\ No newline at end of file
diff --git a/docs/classes/recipe_authRecipe.default.html b/docs/classes/recipe_authRecipe.default.html
index 7d772e77..d2e95c46 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 59eac3ae..0331f9c0 100644
--- a/docs/classes/recipe_emailpassword.default.html
+++ b/docs/classes/recipe_emailpassword.default.html
@@ -1,23 +1,23 @@
-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 a4ab5194..cd0390ea 100644
--- a/docs/classes/recipe_emailverification.default.html
+++ b/docs/classes/recipe_emailverification.default.html
@@ -1,12 +1,12 @@
-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 ff83bf2f..a8e7230b 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 80a545b2..2f74845b 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 3f550a49..3b6aeac9 100644
--- a/docs/classes/recipe_thirdparty.default.html
+++ b/docs/classes/recipe_thirdparty.default.html
@@ -1,32 +1,32 @@
-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 1034470c..5d2c8ce7 100644
--- a/docs/classes/recipe_thirdpartyemailpassword.default.html
+++ b/docs/classes/recipe_thirdpartyemailpassword.default.html
@@ -1,52 +1,52 @@
-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 03ec9ea2..7276857e 100644
--- a/docs/classes/recipe_thirdpartypasswordless.default.html
+++ b/docs/classes/recipe_thirdpartypasswordless.default.html
@@ -1,65 +1,65 @@
-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 4f9b0cb3..3069c1b2 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 1767be29..8d956a13 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 99865bf0..ad73390c 100644
--- a/docs/modules/recipe_emailpassword.html
+++ b/docs/modules/recipe_emailpassword.html
@@ -1,29 +1,29 @@
-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
- 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 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; 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: UserType } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; status: "WRONG_CREDENTIALS_ERROR" }>
-{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: UserType } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
-{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" | "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 673b5f18..fdccaab5 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
Optional updateContextOnIsVerifiedFalse: (userContext: any) => void | Promise<void>
Parameters
userContext: any
Returns void | Promise<void>
Returns EmailVerificationClaimClass
Properties
Readonly default
Readonly id
Readonly refresh
Type declaration
Hierarchy
Index
Constructors
Properties
Methods
Constructors
constructor
Parameters
getRecipeImpl: () => RecipeInterface
Returns RecipeInterface
Optional updateContextOnIsVerifiedFalse: (userContext: any) => void | Promise<void>
Parameters
userContext: any
Returns void | Promise<void>
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 init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static is
- 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 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_passwordless.default.html b/docs/classes/recipe_passwordless.default.html index 4a028bc7..52443389 100644 --- a/docs/classes/recipe_passwordless.default.html +++ b/docs/classes/recipe_passwordless.default.html @@ -1,34 +1,34 @@ -{status: "OK"}if successfull- 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
input: { options?: RecipeFunctionOptions; userContext?: any; userInputCode: string } | { options?: RecipeFunctionOptions; userContext?: any }
Returns Promise<{ createdNewUser: boolean; fetchResponse: Response; status: "OK"; user: PasswordlessUser } | { failedCodeInputAttemptCount: number; fetchResponse: Response; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { fetchResponse: Response; status: "RESTART_FLOW_ERROR" }>
-{status: "OK", user, createdNewUser: 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" }>
-{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 } & 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 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>
Type parameters
Action
NormalisedConfig: NormalisedRecipeConfig<Action>
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Type parameters
Action
NormalisedConfig: 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>
Type parameters
Action
NormalisedConfig: NormalisedRecipeConfig<Action>
Hierarchy
Index
Constructors
Properties
Constructors
constructor
Type parameters
Action
NormalisedConfig: 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<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<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 generate
- Preparing search index...
- The search index is not available
supertokens-web-jsClass default
Hierarchy
Index
Constructors
Methods
Constructors
constructor
Returns default
Methods
Static generate
Generate a new state that will be sent to the third party provider
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
string
-Static get
Static get
Returns the auth code from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
The "code" query param from the current URL. Returns an empty string if no code exists
-Static get
Static get
Returns the error from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string
The "error" query param from the current URL. Returns undefined if no error exists
-Static get
Static get
Returns the auth state from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
The "state" query param from the current URL. Returns an empty string if no state exists
-Static get
Static get
Get the URL to be used by the third party provider for redirecting after the auth flow
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { options?: RecipeFunctionOptions; providerId: string; userContext?: any }
Optional options?: RecipeFunctionOptions
provider
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK"; url: string }>
-{status: "OK", url}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: { authorisationURL: string; options?: RecipeFunctionOptions; providerClientId?: string; providerId: string; userContext?: any }
authorisationURL: string
Optional options?: RecipeFunctionOptions
Optional provider
provider
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 set
Static init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<PreAndPostAPIHookAction>
Static set
Set the login state to storage
-Type parameters
CustomStateProperties
Parameters
input: { state: StateObject & CustomStateProperties; userContext?: any }
state: StateObject & CustomStateProperties
Optional user
Returns Promise<void>
Static sign
Type parameters
CustomStateProperties
Parameters
input: { state: StateObject & CustomStateProperties; userContext?: any }
state: StateObject & CustomStateProperties
Optional user
Returns Promise<void>
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<{ createdNewUser: boolean; fetchResponse: Response; status: "OK"; user: ThirdPartyUserType } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" }>
-{status: OK, user, createdNewUser: boolean}if succesfulStatic sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static verify
Static sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static verify
Verify that the state recieved from the third party provider matches the one in storage
Type parameters
CustomStateProperties
Parameters
input: { stateFromAuthProvider: undefined | string; stateObjectFromStorage: undefined | (StateObject & CustomStateProperties); userContext?: any }
state
state
Optional user
Returns Promise<StateObject & CustomStateProperties>
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: UserType } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" } | { fetchResponse: Response; status: "WRONG_CREDENTIALS_ERROR" }>
-{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: UserType } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
-{status: "OK"}if successfullStatic generate
Static generate
Generate a new state that will be sent to the thirs party provider
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
string
-Static get
Static get
Returns the auth code from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
The "code" query param from the current URL. Returns an empty string if no code exists
-Static get
Static get
Returns the error from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string
The "error" query param from the current URL. Returns undefined if no error exists
-Static get
Static get
Returns the auth state from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
The "state" query param from the current URL. Returns an empty string if no state exists
-Static get
Static get
Get the URL to be used by the third party provider for redirecting after the auth flow
Parameters
input: { options?: RecipeFunctionOptions; providerId: string; userContext?: any }
Optional options?: RecipeFunctionOptions
provider
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK"; url: string }>
-{status: "OK", url}Static get
Static get
Get the URL that should be opened for third party authentication
Parameters
input: { authorisationURL: string; options?: RecipeFunctionOptions; providerClientId?: string; providerId: string; userContext?: any }
authorisationURL: string
Optional options?: RecipeFunctionOptions
Optional provider
provider
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 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; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
-{status: "OK"}if successfullStatic set
Static set
Set the login state to storage
-Type parameters
CustomStateProperties
Parameters
input: { state: StateObject & CustomStateProperties; userContext?: any }
state: StateObject & CustomStateProperties
Optional user
Returns Promise<void>
Static sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static submit
Type parameters
CustomStateProperties
Parameters
input: { state: StateObject & CustomStateProperties; userContext?: any }
state: StateObject & CustomStateProperties
Optional user
Returns Promise<void>
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" | "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<{ createdNewUser: boolean; fetchResponse: Response; status: "OK"; user: ThirdPartyUserType } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" }>
-{status: OK, user, createdNewUser: boolean}if succesfulStatic verify
Static verify
Verify that the state recieved from the third party provider matches the one in storage
Type parameters
CustomStateProperties
Parameters
input: { stateFromAuthProvider: undefined | string; stateObjectFromStorage: undefined | (StateObject & CustomStateProperties); userContext?: any }
state
state
Optional user
Returns Promise<StateObject & CustomStateProperties>
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<{ createdNewUser: boolean; fetchResponse: Response; status: "OK"; user: PasswordlessUser } | { failedCodeInputAttemptCount: number; fetchResponse: Response; maximumCodeInputAttempts: number; status: "INCORRECT_USER_INPUT_CODE_ERROR" | "EXPIRED_USER_INPUT_CODE_ERROR" } | { fetchResponse: Response; status: "RESTART_FLOW_ERROR" }>
-{status: "OK", user, createdNewUser: 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" }>
-{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 generate
Static generate
Generate a new state that will be sent to the thirs party provider
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
string
-Static get
Static get
Get the URL to be used by the third party provider for redirecting after the auth flow
STGeneralError if the API exposed by the backend SDKs returns
status: "GENERAL_ERROR"Parameters
input: { options?: RecipeFunctionOptions; providerId: string; userContext?: any }
Optional options?: RecipeFunctionOptions
provider
Optional user
Returns Promise<{ fetchResponse: Response; status: "OK"; url: string }>
-{status: "OK", url}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 } & 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
Returns the auth code from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
The "code" query param from the current URL. Returns an empty string if no code exists
-Static get
Static get
Returns the error from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns undefined | string
The "error" query param from the current URL. Returns undefined if no error exists
-Static get
Static get
Returns the auth state from the current URL
Parameters
Optional input: { userContext?: any }
Optional user
Returns string
The "state" query param from the current URL. Returns an empty string if no state exists
-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: { authorisationURL: string; options?: RecipeFunctionOptions; providerClientId?: string; providerId: string; userContext?: any }
authorisationURL: string
Optional options?: RecipeFunctionOptions
Optional provider
provider
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 set
Type parameters
CustomStateProperties
Parameters
input: { attemptInfo: { deviceId: string; flowType: PasswordlessFlowType; preAuthSessionId: string } & CustomStateProperties; userContext?: any }
attempt
Optional user
Returns Promise<void>
Static set
Set the login state to storage
-Type parameters
CustomStateProperties
Parameters
input: { state: StateObject & CustomStateProperties; userContext?: any }
state: StateObject & CustomStateProperties
Optional user
Returns Promise<void>
Static sign
Parameters
Optional input: { userContext?: any }
Optional user
Returns Promise<void>
Static third
Type parameters
CustomStateProperties
Parameters
input: { state: StateObject & CustomStateProperties; userContext?: any }
state: StateObject & CustomStateProperties
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<{ createdNewUser: boolean; fetchResponse: Response; status: "OK"; user: ThirdPartyUserType } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER" }>
-{status: OK, user, createdNewUser: boolean}if succesfulStatic verify
Static verify
Verify that the state recieved from the third party provider matches the one in storage
Type parameters
CustomStateProperties
Parameters
input: { stateFromAuthProvider: undefined | string; stateObjectFromStorage: undefined | (StateObject & CustomStateProperties); userContext?: any }
state
state
Optional user
Returns Promise<StateObject & CustomStateProperties>
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-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
Const 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
Const 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