components/github/test

For AI agents: see llms.txt for the complete documentation index. Markdown versions are available by adding .md to a page URL or requesting Accept: text/markdown.

Variables

default

default: object;

Type Declaration

modules

modules: Record<string, () => Promise<unknown>>;

registerGithubOauth

registerGithubOauth: (t, name) => void;

Register the GitHub OAuth component with a convex-test instance.

Parameters

Parameter	Type	Default value	Description
t	TestConvex<SchemaDefinition<GenericSchema, boolean>>	undefined	The test convex instance, e.g. from calling convexTest.
name	string	"authGithub"	The mount name of this component instance, as registered in convex.config.ts. Defaults to "authGithub".

Returns

void

schema

schema: SchemaDefinition<
  {
    accounts: TableDefinition<
      VObject<
        {
          providerAccountId: string;
          userId: string;
        },
        {
          providerAccountId: VString<string, "required">;
          userId: VString<string, "required">;
        },
        "required",
        "userId" | "providerAccountId"
      >,
      {
        providerAccountId: ["providerAccountId", "_creationTime"];
      },
      {},
      {}
    >;
    authorizationRequests: TableDefinition<
      VObject<
        {
          callbackUrl: string;
          codeVerifier: string;
          expiresAt: number;
          redirectTo: string;
          stateHash: string;
        },
        {
          callbackUrl: VString<string, "required">;
          codeVerifier: VString<string, "required">;
          expiresAt: VFloat64<number, "required">;
          redirectTo: VString<string, "required">;
          stateHash: VString<string, "required">;
        },
        "required",
        | "redirectTo"
        | "stateHash"
        | "expiresAt"
        | "callbackUrl"
        | "codeVerifier"
      >,
      {
        stateHash: ["stateHash", "_creationTime"];
      },
      {},
      {}
    >;
    tickets: TableDefinition<
      VObject<
        {
          encryptedPayload: string;
          expiresAt: number;
          stateHash: string;
          ticketCodeHash: string;
        },
        {
          encryptedPayload: VString<string, "required">;
          expiresAt: VFloat64<number, "required">;
          stateHash: VString<string, "required">;
          ticketCodeHash: VString<string, "required">;
        },
        "required",
        "stateHash" | "expiresAt" | "ticketCodeHash" | "encryptedPayload"
      >,
      {
        ticketCodeHash: ["ticketCodeHash", "_creationTime"];
      },
      {},
      {}
    >;
  },
  true
>;

Functions

registerGithubOauth()

function registerGithubOauth(t, name?): void;

Register the GitHub OAuth component with a convex-test instance.

Parameters

Parameter	Type	Default value	Description
t	TestConvex<SchemaDefinition<GenericSchema, boolean>>	undefined	The test convex instance, e.g. from calling convexTest.
name	string	"authGithub"	The mount name of this component instance, as registered in convex.config.ts. Defaults to "authGithub".

Returns

void