supertokens-node
    Preparing search index...

    Type Alias RecipeInterface

    type RecipeInterface = {
        createEmailVerificationToken(
            input: {
                email: string;
                recipeUserId: RecipeUserId;
                tenantId: string;
                userContext: UserContext;
            },
        ): Promise<
            | { status: "OK"; token: string }
            | { status: "EMAIL_ALREADY_VERIFIED_ERROR" },
        >;
        isEmailVerified(
            input: {
                email: string;
                recipeUserId: RecipeUserId;
                userContext: UserContext;
            },
        ): Promise<boolean>;
        revokeEmailVerificationTokens(
            input: {
                email: string;
                recipeUserId: RecipeUserId;
                tenantId: string;
                userContext: UserContext;
            },
        ): Promise<{ status: "OK" }>;
        unverifyEmail(
            input: {
                email: string;
                recipeUserId: RecipeUserId;
                userContext: UserContext;
            },
        ): Promise<{ status: "OK" }>;
        verifyEmailUsingToken(
            input: {
                attemptAccountLinking: boolean;
                tenantId: string;
                token: string;
                userContext: UserContext;
            },
        ): Promise<
            | { status: "OK"; user: UserEmailInfo }
            | { status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" },
        >;
    }
    Index

    Methods

    • Parameters

      • input: {
            email: string;
            recipeUserId: RecipeUserId;
            tenantId: string;
            userContext: UserContext;
        }

      Returns Promise<
          | { status: "OK"; token: string }
          | { status: "EMAIL_ALREADY_VERIFIED_ERROR" },
      >

    • Parameters

      • input: { email: string; recipeUserId: RecipeUserId; userContext: UserContext }

      Returns Promise<boolean>

    • Parameters

      • input: {
            email: string;
            recipeUserId: RecipeUserId;
            tenantId: string;
            userContext: UserContext;
        }

      Returns Promise<{ status: "OK" }>

    • Parameters

      • input: { email: string; recipeUserId: RecipeUserId; userContext: UserContext }

      Returns Promise<{ status: "OK" }>

    • Parameters

      • input: {
            attemptAccountLinking: boolean;
            tenantId: string;
            token: string;
            userContext: UserContext;
        }

      Returns Promise<
          | { status: "OK"; user: UserEmailInfo }
          | { status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" },
      >