\ No newline at end of file
diff --git a/docs/classes/recipe_authRecipe.default.html b/docs/classes/recipe_authRecipe.default.html
index f5b0124a..b27f5558 100644
--- a/docs/classes/recipe_authRecipe.default.html
+++ b/docs/classes/recipe_authRecipe.default.html
@@ -1 +1 @@
-default | supertokens-web-js
\ No newline at end of file
diff --git a/docs/classes/recipe_emailpassword.default.html b/docs/classes/recipe_emailpassword.default.html
index 5ae5983b..8851d0f3 100644
--- a/docs/classes/recipe_emailpassword.default.html
+++ b/docs/classes/recipe_emailpassword.default.html
@@ -1,26 +1,26 @@
-default | supertokens-web-js
\ No newline at end of file
diff --git a/docs/classes/recipe_emailverification.default.html b/docs/classes/recipe_emailverification.default.html
index e0bc18b0..ea5041da 100644
--- a/docs/classes/recipe_emailverification.default.html
+++ b/docs/classes/recipe_emailverification.default.html
@@ -1,15 +1,15 @@
-default | supertokens-web-js
\ No newline at end of file
diff --git a/docs/classes/recipe_multifactorauth.default.html b/docs/classes/recipe_multifactorauth.default.html
index ec4417ef..5ce94255 100644
--- a/docs/classes/recipe_multifactorauth.default.html
+++ b/docs/classes/recipe_multifactorauth.default.html
@@ -1,4 +1,4 @@
-default | supertokens-web-js
\ No newline at end of file
diff --git a/docs/classes/recipe_multitenancy.default.html b/docs/classes/recipe_multitenancy.default.html
index 331e051a..54924cb0 100644
--- a/docs/classes/recipe_multitenancy.default.html
+++ b/docs/classes/recipe_multitenancy.default.html
@@ -1,8 +1,8 @@
-default | supertokens-web-js
\ No newline at end of file
diff --git a/docs/classes/recipe_passwordless.default.html b/docs/classes/recipe_passwordless.default.html
index 663d0c5f..cd4d5b16 100644
--- a/docs/classes/recipe_passwordless.default.html
+++ b/docs/classes/recipe_passwordless.default.html
@@ -1,37 +1,37 @@
-default | supertokens-web-js
\ No newline at end of file
diff --git a/docs/classes/recipe_recipeModule.default.html b/docs/classes/recipe_recipeModule.default.html
index 307274b6..ad0fe157 100644
--- a/docs/classes/recipe_recipeModule.default.html
+++ b/docs/classes/recipe_recipeModule.default.html
@@ -1 +1 @@
-default | supertokens-web-js
\ No newline at end of file
diff --git a/docs/classes/recipe_session.default.html b/docs/classes/recipe_session.default.html
index f12df7d5..fca5243b 100644
--- a/docs/classes/recipe_session.default.html
+++ b/docs/classes/recipe_session.default.html
@@ -1 +1 @@
-default | supertokens-web-js
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdparty.default.html b/docs/classes/recipe_thirdparty.default.html
index 5a783221..536ca893 100644
--- a/docs/classes/recipe_thirdparty.default.html
+++ b/docs/classes/recipe_thirdparty.default.html
@@ -1,12 +1,12 @@
-default | supertokens-web-js
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdpartyemailpassword.default.html b/docs/classes/recipe_thirdpartyemailpassword.default.html
index 41fb4eec..99053675 100644
--- a/docs/classes/recipe_thirdpartyemailpassword.default.html
+++ b/docs/classes/recipe_thirdpartyemailpassword.default.html
@@ -1,37 +1,37 @@
-default | supertokens-web-js
\ No newline at end of file
diff --git a/docs/classes/recipe_thirdpartypasswordless.default.html b/docs/classes/recipe_thirdpartypasswordless.default.html
index c1949f07..cf93a7a8 100644
--- a/docs/classes/recipe_thirdpartypasswordless.default.html
+++ b/docs/classes/recipe_thirdpartypasswordless.default.html
@@ -1,47 +1,47 @@
-default | supertokens-web-js
\ No newline at end of file
diff --git a/docs/classes/recipe_userroles.default.html b/docs/classes/recipe_userroles.default.html
index d1ec0d0b..f949ddc1 100644
--- a/docs/classes/recipe_userroles.default.html
+++ b/docs/classes/recipe_userroles.default.html
@@ -1 +1 @@
-default | supertokens-web-js
\ No newline at end of file
diff --git a/docs/modules/index.html b/docs/modules/index.html
index 6aa89ddc..935cf6ef 100644
--- a/docs/modules/index.html
+++ b/docs/modules/index.html
@@ -1 +1 @@
-index | supertokens-web-js
\ No newline at end of file
diff --git a/docs/modules/recipe_emailpassword.html b/docs/modules/recipe_emailpassword.html
index 749c0aef..66c54592 100644
--- a/docs/modules/recipe_emailpassword.html
+++ b/docs/modules/recipe_emailpassword.html
@@ -1,32 +1,32 @@
-recipe/emailpassword | supertokens-web-js
For the options object passed to recipe functions, we do not need a postAPIHook.
This is because these functions will be called manually, so the user always knows which API is called (making the
postAPIHook redundant). They can consume the networkResponse returned by recipe functions as a way to handle post
API logic
\ No newline at end of file
diff --git a/docs/modules/recipe_emailverification.html b/docs/modules/recipe_emailverification.html
index d5c93562..48166af8 100644
--- a/docs/modules/recipe_emailverification.html
+++ b/docs/modules/recipe_emailverification.html
@@ -1,19 +1,19 @@
-recipe/emailverification | supertokens-web-js
\ No newline at end of file
diff --git a/docs/modules/recipe_multifactorauth.html b/docs/modules/recipe_multifactorauth.html
index d52f56de..710923e4 100644
--- a/docs/modules/recipe_multifactorauth.html
+++ b/docs/modules/recipe_multifactorauth.html
@@ -1 +1 @@
-recipe/multifactorauth | supertokens-web-js
\ No newline at end of file
diff --git a/docs/modules/recipe_multitenancy.html b/docs/modules/recipe_multitenancy.html
index 0a829297..6860c789 100644
--- a/docs/modules/recipe_multitenancy.html
+++ b/docs/modules/recipe_multitenancy.html
@@ -1,5 +1,5 @@
-recipe/multitenancy | supertokens-web-js
\ No newline at end of file
diff --git a/docs/modules/recipe_passwordless.html b/docs/modules/recipe_passwordless.html
index a72bf9da..7622d27a 100644
--- a/docs/modules/recipe_passwordless.html
+++ b/docs/modules/recipe_passwordless.html
@@ -1,37 +1,37 @@
-recipe/passwordless | supertokens-web-js
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static does
Check if an email exists
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
-{status: "OK", doesExist: boolean}Static get
Static get
Reads and returns the reset password token from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
The "token" query parameter from the current location
-Static get
Static get
Reads and returns the tenant id from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string
The "tenantId" query parameter from the current location
-Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static send
Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static send
Send an email to the user for password reset
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; reason: string; status: "PASSWORD_RESET_NOT_ALLOWED" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
-{status: "OK"}if successfullStatic sign
Static sign
Sign in a user with email and password
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; status: "WRONG_CREDENTIALS_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_NOT_ALLOWED" }>
-{status: "OK"}if successfullStatic sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static sign
Static sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static sign
Sign up a user with email and password
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_UP_NOT_ALLOWED" }>
-{status: "OK"}if successfullStatic submit
Static submit
Submit a new password for the user
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
diff --git a/docs/classes/recipe_emailverification.EmailVerificationClaimClass.html b/docs/classes/recipe_emailverification.EmailVerificationClaimClass.html index 255b9306..d0793308 100644 --- a/docs/classes/recipe_emailverification.EmailVerificationClaimClass.html +++ b/docs/classes/recipe_emailverification.EmailVerificationClaimClass.html @@ -1,5 +1,5 @@{status: "OK"}if successfull- Preparing search index...
- The search index is not available
supertokens-web-jsClass EmailVerificationClaimClass
We include "Class" in the class name, because it makes it easier to import/use the right thing (the instance exported by the recipe) instead of this.
-Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
getRecipeImpl: (() => RecipeInterface)
Returns RecipeInterface
Returns EmailVerificationClaimClass
Properties
Readonly default
Readonly id
Readonly refresh
Type declaration
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
getRecipeImpl: (() => RecipeInterface)
Returns RecipeInterface
Returns EmailVerificationClaimClass
Properties
Readonly default
Readonly id
Readonly refresh
Type declaration
Makes an API call that will refresh the claim in the token.
-Parameters
userContext: any
Returns Promise<void>
validators
Methods
get
Parameters
payload: any
Optional _userContext: any
Returns undefined | number
get
Parameters
payload: any
Optional _userContext: any
Returns boolean
Generated using TypeDoc
Parameters
userContext: any
Returns Promise<void>
validators
Methods
get
Parameters
payload: any
Optional _userContext: any
Returns undefined | number
get
Parameters
payload: any
Optional _userContext: any
Returns boolean
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Email
Methods
Static get
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
Static get
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Email
Methods
Static get
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
Static get
Reads and returns the tenant id from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string
The "tenantId" query parameter from the current location
-Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static is
Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static is
Check if an email has been verified
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; isVerified: boolean; status: "OK" }>
-{status: "OK", isVerified: boolean}Static send
Static send
Send an email to the user for verification.
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR" }>
-{status: "OK"}if successfullStatic verify
Static verify
Verify an email
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" }>
diff --git a/docs/classes/recipe_multifactorauth.MultiFactorAuthClaimClass.html b/docs/classes/recipe_multifactorauth.MultiFactorAuthClaimClass.html index f8c0851a..42dbf556 100644 --- a/docs/classes/recipe_multifactorauth.MultiFactorAuthClaimClass.html +++ b/docs/classes/recipe_multifactorauth.MultiFactorAuthClaimClass.html @@ -1,3 +1,3 @@{status: "OK"}if successfull- Preparing search index...
- The search index is not available
supertokens-web-jsClass MultiFactorAuthClaimClass
We include "Class" in the class name, because it makes it easier to import/use the right thing (the instance exported by the recipe) instead of this.
-Hierarchy
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
getRecipeImpl: (() => RecipeInterface)
Returns RecipeInterface
Returns MultiFactorAuthClaimClass
Properties
Protected get
Type declaration
Returns RecipeInterface
id
validators
Type declaration
has
Parameters
requirements: MFARequirementList
Returns SessionClaimValidator
has
Returns SessionClaimValidator
Methods
get
Parameters
payload: any
Optional _userContext: any
Returns undefined | number
get
Parameters
payload: any
Optional _userContext: any
Returns undefined | { c: Record<string, undefined | number>; v: boolean }
refresh
Parameters
userContext: any
Returns Promise<void>
Generated using TypeDoc
Hierarchy
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
getRecipeImpl: (() => RecipeInterface)
Returns RecipeInterface
Returns MultiFactorAuthClaimClass
Properties
Protected get
Type declaration
Returns RecipeInterface
id
validators
Type declaration
has
Parameters
requirements: MFARequirementList
Returns SessionClaimValidator
has
Returns SessionClaimValidator
Methods
get
Parameters
payload: any
Optional _userContext: any
Returns undefined | number
get
Parameters
payload: any
Optional _userContext: any
Returns undefined | { c: Record<string, undefined | number>; v: boolean }
refresh
Parameters
userContext: any
Returns Promise<void>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Multi
Methods
Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<"GET_MFA_INFO">
Static resync
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Multi
Methods
Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<"GET_MFA_INFO">
Static resync
Loads information about what factors the current session can set up/complete and updates the requirements in the session payload
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ emails: Record<string, undefined | string[]>; factors: MFAFactorInfo; fetchResponse: Response; phoneNumbers: Record<string, undefined | string[]>; status: "OK" }>
{ status: "OK", ...}if successfulGenerated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Allowed
Methods
Static get
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Returns default
Properties
Static Allowed
Methods
Static get
Gets enabled login methods and their configuration from the backend
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
Optional input: { options?: RecipeFunctionOptions; tenantId?: string; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional tenant
Optional user
Returns Promise<{ fetchResponse: Response; firstFactors: string[]; status: "OK"; thirdParty: { providers: { id: string; name: string }[] } }>
-{status: OK, emailpassword, passwordless, thirdParty}if successfulStatic get
Static get
Gets enabled login methods and their configuration from the backend
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string | Promise<undefined | string>
-Promise<string | undefined> | string | undefinedStatic init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<"GET_LOGIN_METHODS">
Generated using TypeDoc
Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<"GET_LOGIN_METHODS">
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static clear
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static clear
Clear any information about login attempts from storage
-Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static consume
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static consume
Log the user in using the input code or link code
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any; userInputCode: string } | { options?: RecipeFunctionOptions; userContext?: any }
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { failedCodeInputAttemptCount: number; fetchResponse: Response; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { fetchResponse: Response; status: "RESTART_FLOW_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
-{status: "OK", user, createdNewRecipeUser: bool}if succesfulStatic create
Static create
Create and send a code to the user for passwordless auth
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any } | { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Returns Promise<{ deviceId: string; fetchResponse: Response; flowType: PasswordlessFlowType; preAuthSessionId: string; status: "OK" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
-{status: "OK", deviceId, preAuthSessionId, flowType}If successfulStatic does
Static does
Check if a user with the given email exists
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
-{status: "OK", doesExist: boolean}Static does
Static does
Check if a user with the given phone number exists
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Optional options?: RecipeFunctionOptions
phone
Optional user
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
-{status: "OK", doesExist: boolean}Static get
Static get
Reads and returns the link code from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
The hash (#) property of the current URL
-Static get
Static get
Get information about the current login attempt from storage
Type Parameters
CustomLoginAttemptInfoProperties
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<undefined | { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string; tenantId?: string } & CustomLoginAttemptInfoProperties>
-{deviceId, preAuthSessionId, flowType}if present, returns undefined otherwiseStatic get
Static get
Reads and returns the pre auth session id from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
The "preAuthSessionId" query parameter from the current URL
-Static get
Static get
Reads and returns the tenant id from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string
The "tenantId" query parameter from the current location
-Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static resend
Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static resend
Resend the code to the user
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" | "RESTART_FLOW_ERROR" }>
-{status: "OK"}if succesfulStatic set
Static set
Set information about the current login attempt to storage
-Type Parameters
CustomStateProperties
Parameters
input: { attemptInfo: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties; userContext?: any }
attempt
Optional user
Returns Promise<void>
Static sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Generated using TypeDoc
Type Parameters
CustomStateProperties
Parameters
input: { attemptInfo: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties; userContext?: any }
attempt
Optional user
Returns Promise<void>
Static sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default<Action, NormalisedConfig> Abstract
Type Parameters
Action
NormalisedConfig extends NormalisedRecipeConfig<Action>
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Type Parameters
Action
NormalisedConfig extends NormalisedRecipeConfig<Action>
Parameters
config: NormalisedConfig
Returns default<Action, NormalisedConfig>
Properties
config
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default<Action, NormalisedConfig> Abstract
Type Parameters
Action
NormalisedConfig extends NormalisedRecipeConfig<Action>
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Type Parameters
Action
NormalisedConfig extends NormalisedRecipeConfig<Action>
Parameters
config: NormalisedConfig
Returns default<Action, NormalisedConfig>
Properties
config
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static add
Parameters
axiosInstance: any
Optional userContext: any
Returns void
Static attempt
Returns Promise<boolean>
Static does
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<boolean>
Static get
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<undefined | string>
Static get
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<any>
Static get
Type Parameters
T
Parameters
input: { claim: SessionClaim<T>; userContext?: any }
claim: SessionClaim<T>
Optional user
Returns Promise<undefined | T>
Static get
Parameters
input: { response: Response | { data: any }; userContext?: any }
response: Response | { data: any }
Optional user
Returns Promise<ClaimValidationError[]>
Static get
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<string>
Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<unknown>
Static sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static validate
Parameters
Optional input: { userContext?: any; overrideGlobalClaimValidators?: any }
Optional user
override
Parameters
globalClaimValidators: SessionClaimValidator[]
userContext: any
Returns SessionClaimValidator[]
Returns ClaimValidationError[] | Promise<ClaimValidationError[]>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static add
Parameters
axiosInstance: any
Optional userContext: any
Returns void
Static attempt
Returns Promise<boolean>
Static does
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<boolean>
Static get
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<undefined | string>
Static get
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<any>
Static get
Type Parameters
T
Parameters
input: { claim: SessionClaim<T>; userContext?: any }
claim: SessionClaim<T>
Optional user
Returns Promise<undefined | T>
Static get
Parameters
input: { response: Response | { data: any }; userContext?: any }
response: Response | { data: any }
Optional user
Returns Promise<ClaimValidationError[]>
Static get
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<string>
Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<unknown>
Static sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static validate
Parameters
Optional input: { userContext?: any; overrideGlobalClaimValidators?: any }
Optional user
override
Parameters
globalClaimValidators: SessionClaimValidator[]
userContext: any
Returns SessionClaimValidator[]
Returns ClaimValidationError[] | Promise<ClaimValidationError[]>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static get
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static get
Get the URL that should be opened for third party authentication
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend
Optional options?: RecipeFunctionOptions
Optional redirectURIOn
third
Optional user
Returns Promise<string>
URL string
-Static get
Static get
Get the current login state from storage, this is also used when calling signInUp
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | StateObject & CustomStateProperties
State object from storage
-Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static sign
Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static sign
Sign up/Sign in the user, this method uses the login attempt information from storage
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
-{status: OK, user, createdNewRecipeUser: boolean}if successfulStatic sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Generated using TypeDoc
Static sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static does
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static does
Check if an email exists
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
-{status: "OK", doesExist: boolean}Static email
Static email
Sign in a user with email and password
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; status: "WRONG_CREDENTIALS_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_NOT_ALLOWED" }>
-{status: "OK"}if successfullStatic email
Static email
Sign up a user with email and password
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_UP_NOT_ALLOWED" }>
-{status: "OK"}if successfullStatic get
Static get
Get the URL that should be opened for third party authentication
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend
Optional options?: RecipeFunctionOptions
Optional redirectURIOn
third
Optional user
Returns Promise<string>
URL string
-Static get
Static get
Reads and returns the reset password token from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
The "token" query parameter from the current location
-Static get
Static get
Get the current login state from storage, this is also used when calling signInUp
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | StateObject & CustomStateProperties
State object from storage
-Static get
Static get
Reads and returns the tenant id from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string
The "tenantId" query parameter from the current location
-Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static send
Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static send
Send an email to the user for password reset
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; reason: string; status: "PASSWORD_RESET_NOT_ALLOWED" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
-{status: "OK"}if successfullStatic sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static submit
Static sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static submit
Submit a new password for the user
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
-{status: "OK"}if successfullStatic third
Static third
Sign up/Sign in the user, this method uses the login attempt information from storage
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
{status: OK, user, createdNewRecipeUser: boolean}if succesfulGenerated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static clear
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static clear
Clear any information about login attempts from storage
-Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static consume
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static consume
Log the user in using the input code or link code
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any; userInputCode: string } | { options?: RecipeFunctionOptions; userContext?: any }
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { failedCodeInputAttemptCount: number; fetchResponse: Response; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { fetchResponse: Response; status: "RESTART_FLOW_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
-{status: "OK", user, createdNewRecipeUser: bool}if succesfulStatic create
Static create
Create and send a code to the user for passwordless auth
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any } | { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Returns Promise<{ deviceId: string; fetchResponse: Response; flowType: PasswordlessFlowType; preAuthSessionId: string; status: "OK" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
-{status: "OK", deviceId, preAuthSessionId, flowType}If successfulStatic does
Static does
Check if a user with the given email exists
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
-{status: "OK", doesExist: boolean}Static does
Static does
Check if a user with the given phone number exists
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { options?: RecipeFunctionOptions; phoneNumber: string; userContext?: any }
Optional options?: RecipeFunctionOptions
phone
Optional user
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
-{status: "OK", doesExist: boolean}Static get
Static get
Reads and returns the link code from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
The hash (#) property of the current URL
-Static get
Static get
Get information about the current login attempt from storage
Type Parameters
CustomLoginAttemptInfoProperties
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<undefined | { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string; tenantId: undefined | string } & CustomLoginAttemptInfoProperties>
-{deviceId, preAuthSessionId, flowType}if present, returns undefined otherwiseStatic get
Static get
Reads and returns the pre auth session id from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
The "preAuthSessionId" query parameter from the current URL
-Static get
Static get
Reads and returns the tenant id from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string
The "tenantId" query parameter from the current location
-Static get
Static get
Get the URL that should be opened for third party authentication
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { frontendRedirectURI: string; options?: RecipeFunctionOptions; redirectURIOnProviderDashboard?: string; thirdPartyId: string; userContext?: any }
frontend
Optional options?: RecipeFunctionOptions
Optional redirectURIOn
third
Optional user
Returns Promise<string>
URL string
-Static get
Static get
Get the current login state from storage, this is also used when calling signInUp
Type Parameters
CustomStateProperties
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | StateObject & CustomStateProperties
State object from storage
-Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static resend
Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static resend
Resend the code to the user
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" | "RESTART_FLOW_ERROR" }>
-{status: "OK"}if succesfulStatic set
Static set
Set information about the current login attempt to storage
-Type Parameters
CustomStateProperties
Parameters
input: { attemptInfo: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties; userContext?: any }
attempt
Optional user
Returns Promise<void>
Static sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static third
Type Parameters
CustomStateProperties
Parameters
input: { attemptInfo: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties; userContext?: any }
attempt
Optional user
Returns Promise<void>
Static sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static third
Sign up/Sign in the user, this method uses the login attempt information from storage
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
diff --git a/docs/classes/recipe_totp.default.html b/docs/classes/recipe_totp.default.html index 43f0f7bf..e8b994f1 100644 --- a/docs/classes/recipe_totp.default.html +++ b/docs/classes/recipe_totp.default.html @@ -1,16 +1,16 @@ -{status: OK, user, createdNewRecipeUser: boolean}if succesful- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static create
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static create
Creates a new unverified device.
Parameters
Optional input: { deviceName?: string; options?: RecipeFunctionOptions; userContext?: any }
Optional device
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ deviceName: string; fetchResponse: Response; qrCodeString: string; secret: string; status: "OK" } | { fetchResponse: Response; status: "DEVICE_ALREADY_EXISTS_ERROR" }>
-{ status: "OK", ...}if successful along a description of the created device (secret, etc.)Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static list
Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static list
Lists all TOTP devices of the current user
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ devices: { name: string; period: number; skew: number; verified: boolean }[]; fetchResponse: Response; status: "OK" }>
-{ status: "OK", ...}if successful with a list of devices in thedevicespropStatic remove
Static remove
Removes a TOTP device
Parameters
input: { deviceName: string; options?: RecipeFunctionOptions; userContext?: any }
device
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ didDeviceExist: boolean; fetchResponse: Response; status: "OK" }>
-{ status: "OK", ...}if successfulStatic verify
Static verify
Verifies that the totp code belongs to a verified device of the current user
Parameters
input: { options?: RecipeFunctionOptions; totp: string; userContext?: any }
Optional options?: RecipeFunctionOptions
totp: string
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" } | { currentNumberOfFailedAttempts: number; fetchResponse: Response; maxNumberOfFailedAttempts: number; status: "INVALID_TOTP_ERROR" } | { fetchResponse: Response; retryAfterMs: number; status: "LIMIT_REACHED_ERROR" }>
-{ status: "OK", ...}if successfulStatic verify
Static verify
Verifies the totp device for the current user
Parameters
input: { deviceName: string; options?: RecipeFunctionOptions; totp: string; userContext?: any }
device
Optional options?: RecipeFunctionOptions
totp: string
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK"; wasAlreadyVerified: boolean } | { currentNumberOfFailedAttempts: number; fetchResponse: Response; maxNumberOfFailedAttempts: number; status: "INVALID_TOTP_ERROR" } | { fetchResponse: Response; status: "UNKNOWN_DEVICE_ERROR" } | { fetchResponse: Response; retryAfterMs: number; status: "LIMIT_REACHED_ERROR" }>
{ status: "OK", ...}if successfulGenerated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Returns default
Properties
Static Permission
Static User
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Returns default
Properties
Static Permission
Static User
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsModule index
Index
Classes
Functions
Functions
init
Parameters
config: SuperTokensConfig
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsModule index
Index
Classes
Functions
Functions
init
Parameters
config: SuperTokensConfig
Returns void
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsModule recipe/emailpassword
Index
Classes
Type Aliases
Functions
Type Aliases
PostAPIHook
PreAPIHook
Recipe
- Preparing search index...
- The search index is not available
supertokens-web-jsModule recipe/emailpassword
Index
Classes
Type Aliases
Functions
Type Aliases
PostAPIHook
PreAPIHook
Recipe
For the options object passed to recipe functions, we do not need a postAPIHook.
This is because these functions will be called manually, so the user always knows which API is called (making the postAPIHook redundant). They can consume the networkResponse returned by recipe functions as a way to handle post API logic
-Type declaration
preAPIHook?:function
Parameters
input: { requestInit: RequestInit; url: string; userContext: any }
request
url: string
user
Returns Promise<{ requestInit: RequestInit; url: string }>
Recipe
Type declaration
does
Type declaration
preAPIHook?:function
Parameters
input: { requestInit: RequestInit; url: string; userContext: any }
request
url: string
user
Returns Promise<{ requestInit: RequestInit; url: string }>
Recipe
Type declaration
does
Check if an email exists
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext: any }
email: string
Optional options?: RecipeFunctionOptions
user
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
-{status: "OK", doesExist: boolean}get
get
Reads and returns the reset password token from the current URL
Parameters
input: { userContext: any }
user
Returns string
The "token" query parameter from the current location
-get
get
Reads and returns the tenant id from the current URL
Parameters
input: { userContext: any }
user
Returns undefined | string
The "tenantId" query parameter from the current location
-send
send
Send an email to the user for password reset
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext: any }
form
Optional options?: RecipeFunctionOptions
user
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; reason: string; status: "PASSWORD_RESET_NOT_ALLOWED" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
-{status: "OK"}if successfullsign
sign
Sign in a user with email and password
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext: any }
form
Optional options?: RecipeFunctionOptions
user
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; status: "WRONG_CREDENTIALS_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_NOT_ALLOWED" }>
-{status: "OK"}if successfullsign
sign
Sign up a user with email and password
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext: any }
form
Optional options?: RecipeFunctionOptions
user
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_UP_NOT_ALLOWED" }>
-{status: "OK"}if successfullsubmit
submit
Submit a new password for the user
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext: any }
form
Optional options?: RecipeFunctionOptions
user
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
-{status: "OK"}if successfullUser
Functions
does
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
get
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
get
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string
init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
send
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; reason: string; status: "PASSWORD_RESET_NOT_ALLOWED" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
sign
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; status: "WRONG_CREDENTIALS_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_NOT_ALLOWED" }>
sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
sign
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_UP_NOT_ALLOWED" }>
submit
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
Generated using TypeDoc
User
Functions
does
Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext?: any }
email: string
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
get
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
get
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string
init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
send
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; reason: string; status: "PASSWORD_RESET_NOT_ALLOWED" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
sign
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; status: "WRONG_CREDENTIALS_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_NOT_ALLOWED" }>
sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
sign
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK"; user: User } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_UP_NOT_ALLOWED" }>
submit
Parameters
input: { formFields: { id: string; value: string }[]; options?: RecipeFunctionOptions; userContext?: any }
form
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" } | { fetchResponse: Response; status: "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsModule recipe/emailverification
Index
References
Classes
Type Aliases
Variables
Functions
References
Recipe
Re-exports RecipeFunctionOptionsType Aliases
PostAPIHook
PreAPIHook
Recipe
Type declaration
get
- Preparing search index...
- The search index is not available
supertokens-web-jsModule recipe/emailverification
Index
References
Classes
Type Aliases
Variables
Functions
References
Recipe
Re-exports RecipeFunctionOptionsType Aliases
PostAPIHook
PreAPIHook
Recipe
Type declaration
get
Reads and returns the email verification token from the current URL
Parameters
input: { userContext: any }
user
Returns string
The "token" query parameter from the current location
-get
get
Reads and returns the tenant id from the current URL
Parameters
input: { userContext: any }
user
Returns undefined | string
The "tenantId" query parameter from the current location
-is
is
Check if an email has been verified
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { options?: RecipeFunctionOptions; userContext: any }
Optional options?: RecipeFunctionOptions
user
Returns Promise<{ fetchResponse: Response; isVerified: boolean; status: "OK" }>
-{status: "OK", isVerified: boolean}send
send
Send an email to the user for verification.
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { options?: RecipeFunctionOptions; userContext: any }
Optional options?: RecipeFunctionOptions
user
Returns Promise<{ fetchResponse: Response; status: "EMAIL_ALREADY_VERIFIED_ERROR" | "OK" }>
-{status: "OK"}if successfullverify
verify
Verify an email
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { options?: RecipeFunctionOptions; userContext: any }
Optional options?: RecipeFunctionOptions
user
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" }>
-{status: "OK"}if successfullUser
Variables
Const Email
Functions
get
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
get
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string
init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
is
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; isVerified: boolean; status: "OK" }>
send
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR" }>
verify
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" }>
Generated using TypeDoc
User
Variables
Const Email
Functions
get
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
get
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string
init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
is
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; isVerified: boolean; status: "OK" }>
send
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_ALREADY_VERIFIED_ERROR" }>
verify
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" }>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsModule recipe/multifactorauth
Index
References
Classes
Type Aliases
Variables
Functions
References
Recipe
Re-exports RecipeFunctionOptionsType Aliases
PostAPIHook
PreAPIHook
Pre
Recipe
Type declaration
resync
Parameters
input: { options?: RecipeFunctionOptions; userContext: any }
Optional options?: RecipeFunctionOptions
user
Returns Promise<{ emails: Record<string, string[] | undefined>; factors: MFAFactorInfo; fetchResponse: Response; phoneNumbers: Record<string, string[] | undefined>; status: "OK" }>
User
Variables
Const Multi
Functions
init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<"GET_MFA_INFO">
resync
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ emails: Record<string, undefined | string[]>; factors: MFAFactorInfo; fetchResponse: Response; phoneNumbers: Record<string, undefined | string[]>; status: "OK" }>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsModule recipe/multifactorauth
Index
References
Classes
Type Aliases
Variables
Functions
References
Recipe
Re-exports RecipeFunctionOptionsType Aliases
PostAPIHook
PreAPIHook
Pre
Recipe
Type declaration
resync
Parameters
input: { options?: RecipeFunctionOptions; userContext: any }
Optional options?: RecipeFunctionOptions
user
Returns Promise<{ emails: Record<string, string[] | undefined>; factors: MFAFactorInfo; fetchResponse: Response; phoneNumbers: Record<string, string[] | undefined>; status: "OK" }>
User
Variables
Const Multi
Functions
init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<"GET_MFA_INFO">
resync
Parameters
Optional input: { options?: RecipeFunctionOptions; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional user
Returns Promise<{ emails: Record<string, undefined | string[]>; factors: MFAFactorInfo; fetchResponse: Response; phoneNumbers: Record<string, undefined | string[]>; status: "OK" }>
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsModule recipe/multitenancy
Index
Classes
Type Aliases
Variables
Functions
Type Aliases
PostAPIHook
PreAPIHook
Pre
Recipe
Type declaration
get
- Preparing search index...
- The search index is not available
supertokens-web-jsModule recipe/multitenancy
Index
Classes
Type Aliases
Variables
Functions
Type Aliases
PostAPIHook
PreAPIHook
Pre
Recipe
Type declaration
get
Gets enabled login methods and their configuration
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { options?: RecipeFunctionOptions; tenantId?: string; userContext: any }
Optional options?: RecipeFunctionOptions
Optional tenant
user
Returns Promise<{ fetchResponse: Response; firstFactors: string[]; status: "OK"; thirdParty: { providers: { id: string; name: string }[] } }>
-{status: OK, emailpassword, passwordless, thirdParty}if successfulget
Parameters
input: { userContext: any }
user
Returns undefined | string | Promise<undefined | string>
User
Variables
Const Allowed
Functions
get
Parameters
Optional input: { options?: RecipeFunctionOptions; tenantId?: string; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional tenant
Optional user
Returns Promise<{ fetchResponse: Response; firstFactors: string[]; status: "OK"; thirdParty: { providers: { id: string; name: string }[] } }>
get
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string | Promise<undefined | string>
init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<"GET_LOGIN_METHODS">
Generated using TypeDoc
get
Parameters
input: { userContext: any }
user
Returns undefined | string | Promise<undefined | string>
User
Variables
Const Allowed
Functions
get
Parameters
Optional input: { options?: RecipeFunctionOptions; tenantId?: string; userContext?: any }
Optional options?: RecipeFunctionOptions
Optional tenant
Optional user
Returns Promise<{ fetchResponse: Response; firstFactors: string[]; status: "OK"; thirdParty: { providers: { id: string; name: string }[] } }>
get
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string | Promise<undefined | string>
init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<"GET_LOGIN_METHODS">
Generated using TypeDoc
- Preparing search index...
- The search index is not available
supertokens-web-jsModule recipe/passwordless
Index
References
Classes
Type Aliases
Functions
References
Recipe
Re-exports RecipeFunctionOptionsType Aliases
PostAPIHook
PreAPIHook
Pre
Recipe
Type declaration
clear
- Preparing search index...
- The search index is not available
supertokens-web-jsModule recipe/passwordless
Index
References
Classes
Type Aliases
Functions
References
Recipe
Re-exports RecipeFunctionOptionsType Aliases
PostAPIHook
PreAPIHook
Pre
Recipe
Type declaration
clear
Clear any information about login attempts from storage
-Parameters
input: { userContext: any }
user
Returns Promise<void>
consume
Parameters
input: { userContext: any }
user
Returns Promise<void>
consume
Log the user in using the input code or link code
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { deviceId: string; options?: RecipeFunctionOptions; preAuthSessionId: string; tenantId: string | undefined; userContext: any; userInputCode: string } | { linkCode: string; options?: RecipeFunctionOptions; preAuthSessionId: string; tenantId: string | undefined; userContext: any }
Returns Promise<{ createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; user: User } | { failedCodeInputAttemptCount: number; fetchResponse: Response; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { fetchResponse: Response; status: "RESTART_FLOW_ERROR" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
-{status: "OK", user, createdNewRecipeUser: bool}if succesfulcreate
create
Create and send a code to the user for passwordless auth
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext: any } | { options?: RecipeFunctionOptions; phoneNumber: string; userContext: any }
Returns Promise<{ deviceId: string; fetchResponse: Response; flowType: PasswordlessFlowType; preAuthSessionId: string; status: "OK" } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED" }>
-{status: "OK", deviceId, preAuthSessionId, flowType}If successfuldoes
does
Check if a user with the given email exists
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { email: string; options?: RecipeFunctionOptions; userContext: any }
email: string
Optional options?: RecipeFunctionOptions
user
Returns Promise<{ doesExist: boolean; fetchResponse: Response; status: "OK" }>
-{status: "OK", doesExist: boolean}does
does
Check if a user with the given phone number exists
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { options?: RecipeFunctionOptions; phoneNumber: string; userContext: any }