Type Aliases Get Get: AuthRecipeModuleGetRedirectionURLContext
On On: { action: "SUCCESS" ; isNewUser: boolean ; user: PasswordlessUser } | { action: "PASSWORDLESS_RESTART_FLOW" } | { action: "PASSWORDLESS_CODE_SENT" ; isResend: boolean } | AuthRecipeModuleOnHandleEventContext
PreAPIHook PreAPIHook: { action: PreAndPostAPIHookAction ; requestInit: RequestInit ; url: string }
Type declaration action: PreAndPostAPIHookAction request: RequestInit url: string Recipe Recipe: { clearLoginAttemptInfo: any ; consumeCode: any ; createCode: any ; doesEmailExist: any ; doesPhoneNumberExist: any ; getLinkCodeFromURL: any ; getLoginAttemptInfo: any ; getPreAuthSessionIdFromURL: any ; resendCode: any ; setLoginAttemptInfo: any }
Defined in node_modules/supertokens-web-js/lib/build/recipe/passwordless/types.d.ts:45 Type declaration clear: function clear( input: { userContext: any } ) : Promise < void > Defined in node_modules/supertokens-web-js/lib/build/recipe/passwordless/types.d.ts:253 User User
Input
: ( { contactMethod
: "EMAIL" ; signInUpFeature
?: SignInUpFeatureConfigInput ; validateEmailAddress
?: any } | { contactMethod
: "PHONE" ; signInUpFeature
?: SignInUpFeatureConfigInput & { defaultCountry
?: CountryCode } ; validatePhoneNumber
?: any } | { contactMethod
: "EMAIL_OR_PHONE" ; signInUpFeature
?: SignInUpFeatureConfigInput & { defaultCountry
?: CountryCode ; guessInternationPhoneNumberFromInputPhoneNumber
?: any } ; validateEmailAddress
?: any ; validatePhoneNumber
?: any } ) & { linkClickedScreenFeature
?: PasswordlessFeatureBaseConfig ; override
?: { components
?: ComponentOverrideMap ; functions
?: any } } & AuthRecipeModuleUserInput < GetRedirectionURLContext , PreAndPostAPIHookAction , OnHandleEventContext > Functions Link Link( prop?: any ) : Element Parameters Returns Element Sign Sign( prop?: PropsWithChildren < { redirectOnSessionExists?: boolean ; userContext?: any } > ) : Element Parameters prop: PropsWithChildren < { redirectOnSessionExists?: boolean ; userContext?: any } > = {} Returns Element Sign Sign( props: SignInUpProps ) : JSX.Element Parameters Returns JSX.Element clear clear( input?: { userContext?: any } ) : Promise < void > Parameters Optional input: { userContext?: any } Optional user?: any Returns Promise < void > consume consume( input: { options?: RecipeFunctionOptions ; userContext?: any ; userInputCode: string } | { options?: RecipeFunctionOptions ; userContext?: any } ) : 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" } > 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" } > create create( input: { email: string ; options?: RecipeFunctionOptions ; userContext?: any } | { options?: RecipeFunctionOptions ; phoneNumber: string ; userContext?: any } ) : Promise < { deviceId: string ; fetchResponse: Response ; flowType: PasswordlessFlowType ; preAuthSessionId: string ; status: "OK" } > 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" } > does does( input: { email: string ; options?: RecipeFunctionOptions ; userContext?: any } ) : Promise < { doesExist: boolean ; fetchResponse: Response ; status: "OK" } > Parameters input: { email: string ; options?: RecipeFunctionOptions ; userContext?: any } email: string Optional options?: RecipeFunctionOptions Optional user?: any Returns Promise < { doesExist: boolean ; fetchResponse: Response ; status: "OK" } > does does( input: { options?: RecipeFunctionOptions ; phoneNumber: string ; userContext?: any } ) : Promise < { doesExist: boolean ; fetchResponse: Response ; status: "OK" } > Parameters input: { options?: RecipeFunctionOptions ; phoneNumber: string ; userContext?: any } Optional options?: RecipeFunctionOptions phone: string Optional user?: any Returns Promise < { doesExist: boolean ; fetchResponse: Response ; status: "OK" } > get get( input?: { userContext?: any } ) : string Parameters Optional input: { userContext?: any } Optional user?: any Returns string get get< CustomLoginAttemptInfoProperties > ( input?: { userContext?: any } ) : Promise < undefined | { deviceId: string ; flowType: PasswordlessFlowType ; preAuthSessionId: string } & CustomLoginAttemptInfoProperties > Type Parameters CustomLoginAttemptInfoProperties Parameters Optional input: { userContext?: any } Optional user?: any Returns Promise < undefined | { deviceId: string ; flowType: PasswordlessFlowType ; preAuthSessionId: string } & CustomLoginAttemptInfoProperties > get get( input?: { userContext?: any } ) : string Parameters Optional input: { userContext?: any } Optional user?: any Returns string init Parameters Returns CreateRecipeFunction < GetRedirectionURLContext , PreAndPostAPIHookAction , OnHandleEventContext , NormalisedConfig > resend resend( input?: { options?: RecipeFunctionOptions ; userContext?: any } ) : Promise < { fetchResponse: Response ; status: "OK" | "RESTART_FLOW_ERROR" } > Parameters Optional input: { options?: RecipeFunctionOptions ; userContext?: any } Optional options?: RecipeFunctionOptions Optional user?: any Returns Promise < { fetchResponse: Response ; status: "OK" | "RESTART_FLOW_ERROR" } > set set< CustomStateProperties > ( input: { attemptInfo: { deviceId: string ; flowType: PasswordlessFlowType ; preAuthSessionId: string } & CustomStateProperties ; userContext?: any } ) : Promise < void > Type Parameters Parameters input: { attemptInfo: { deviceId: string ; flowType: PasswordlessFlowType ; preAuthSessionId: string } & CustomStateProperties ; userContext?: any } attempt: { deviceId: string ; flowType: PasswordlessFlowType ; preAuthSessionId: string } & CustomStateProperties Optional user?: any Returns Promise < void > sign sign( input?: { userContext?: any } ) : Promise < void > Parameters Optional input: { userContext?: any } Optional user?: any Returns Promise < void > Legend Variable Function Function with type parameter Type alias Class Class with type parameter Settings Theme OS Light Dark
\ No newline at end of file
diff --git a/docs/modules/recipe_session.html b/docs/modules/recipe_session.html
index b2090b761..fc1f24a1e 100644
--- a/docs/modules/recipe_session.html
+++ b/docs/modules/recipe_session.html
@@ -1 +1 @@
-
recipe/session | supertokens-auth-react Type Aliases Claim Claim: { reason?: any ; validatorId: string }
Defined in node_modules/supertokens-website/lib/build/types.d.ts:119 Type declaration Optional reason?: any validator: string Claim Claim: { isValid: true } | { isValid: false ; reason?: any }
Defined in node_modules/supertokens-website/lib/build/types.d.ts:113 Input Input: WebJSInputType & { onHandleEvent?: any }
Recipe Recipe: { addAxiosInterceptors: any ; addFetchInterceptorsAndReturnModifiedFetch: any ; doesSessionExist: any ; getAccessTokenPayloadSecurely: any ; getGlobalClaimValidators: any ; getInvalidClaimsFromResponse: any ; getUserId: any ; signOut: any ; validateClaims: any }
Defined in node_modules/supertokens-website/lib/build/types.d.ts:77 Type declaration add: function add( input: { axiosInstance: any ; userContext: any } ) : void Defined in node_modules/supertokens-website/lib/build/types.d.ts:82 Parameters input: { axiosInstance: any ; userContext: any } axios: any user: any Returns void add: function add( input: { originalFetch: any ; userContext: any } ) : ( ( input: URL | RequestInfo , init?: RequestInit ) => Promise < Response > ) Defined in node_modules/supertokens-website/lib/build/types.d.ts:78 Parameters input: { originalFetch: any ; userContext: any } original: any user: any Returns ( ( input: URL | RequestInfo , init?: RequestInit ) => Promise < Response > ) ( input: URL | RequestInfo , init?: RequestInit ) : Promise < Response > Parameters input: URL | RequestInfo Optional init: RequestInit Returns Promise < Response > does: function does( input: { userContext: any } ) : Promise < boolean > Defined in node_modules/supertokens-website/lib/build/types.d.ts:92 Parameters input: { userContext: any } Returns Promise < boolean > get: function get( input: { userContext: any } ) : Promise < any > Defined in node_modules/supertokens-website/lib/build/types.d.ts:89 Parameters input: { userContext: any } Returns Promise < any > get: function Defined in node_modules/supertokens-website/lib/build/types.d.ts:108 Parameters get: function get( input: { response: { data: any } | Response ; userContext: any } ) : Promise < ClaimValidationError [] > Defined in node_modules/supertokens-website/lib/build/types.d.ts:98 Parameters input: { response: { data: any } | Response ; userContext: any } response: { data: any } | Response user: any get: function get( input: { userContext: any } ) : Promise < string > Defined in node_modules/supertokens-website/lib/build/types.d.ts:86 Parameters input: { userContext: any } Returns Promise < string > sign: function sign( input: { userContext: any } ) : Promise < void > Defined in node_modules/supertokens-website/lib/build/types.d.ts:95 Parameters input: { userContext: any } Returns Promise < void > validate: function Defined in node_modules/supertokens-website/lib/build/types.d.ts:104 Parameters Session Session< ValueType > : { getLastFetchedTime: any ; getValueFromPayload: any ; refresh: any }
Defined in node_modules/supertokens-website/lib/build/types.d.ts:140 Type Parameters Type declaration get: function get( payload: any , _userContext?: any ) : undefined | number Defined in node_modules/supertokens-website/lib/build/types.d.ts:143 Parameters payload: any Optional _userContext: any Returns undefined | number get: function get( payload: any , _userContext?: any ) : undefined | ValueType Defined in node_modules/supertokens-website/lib/build/types.d.ts:142 Parameters payload: any Optional _userContext: any Returns undefined | ValueType refresh: function refresh( userContext: any ) : Promise < void > Defined in node_modules/supertokens-website/lib/build/types.d.ts:141 Parameters Returns Promise < void > Session Session: LoadedSessionContext | { loading: true }
Variables Const SessionSession: FC < PropsWithChildren < SessionAuthProps & { userContext?: any } > > = SessionAPIWrapper.SessionAuth
Const SessionSession
Context
: Context < { invalidClaims
: ClaimValidationError [] ; loading
: false } & SessionContextUpdate & { isDefault
?: boolean } & { loading
: true } & { isDefault
?: boolean } > = ... Functions add add( axiosInstance: any , userContext?: any ) : void Parameters axiosInstance: any Optional userContext: any Returns void attempt attempt( ) : Promise < boolean > does does( input?: { userContext?: any } ) : Promise < boolean > Parameters Optional input: { userContext?: any } Optional user?: any Returns Promise < boolean > get get( input?: { userContext?: any } ) : Promise < any > Parameters Optional input: { userContext?: any } Optional user?: any Returns Promise < any > get get( input: { response: Response | { data: any } ; userContext: any } ) : Promise < ClaimValidationError [] > Parameters input: { response: Response | { data: any } ; userContext: any } response: Response | { data: any } user: any get get( input?: { userContext?: any } ) : Promise < string > Parameters Optional input: { userContext?: any } Optional user?: any Returns Promise < string > init init( config?: InputType ) : CreateRecipeFunction < unknown , unknown , unknown , any > Parameters Returns CreateRecipeFunction < unknown , unknown , unknown , any > sign sign( input?: { userContext?: any } ) : Promise < void > Parameters Optional input: { userContext?: any } Optional user?: any Returns Promise < void > use use< T > ( claim: SessionClaim < T > ) : { loading: true } | { doesSessionExist: boolean ; loading: false ; value: undefined | T } Type Parameters Parameters Returns { loading: true } | { doesSessionExist: boolean ; loading: false ; value: undefined | T } validate Parameters input: { userContext: any ; overrideGlobalClaimValidators?: any } user: any override?: function Legend Variable Function Function with type parameter Type alias Class Class with type parameter Settings Theme OS Light Dark
\ No newline at end of file
+
recipe/session | supertokens-auth-react Type Aliases Claim Claim: { reason?: any ; validatorId: string }
Defined in node_modules/supertokens-website/lib/build/types.d.ts:119 Type declaration Optional reason?: any validator: string Claim Claim: { isValid: true } | { isValid: false ; reason?: any }
Defined in node_modules/supertokens-website/lib/build/types.d.ts:113 Input Input: WebJSInputType & { onHandleEvent?: any }
Recipe Recipe: { addAxiosInterceptors: any ; addFetchInterceptorsAndReturnModifiedFetch: any ; doesSessionExist: any ; getAccessTokenPayloadSecurely: any ; getGlobalClaimValidators: any ; getInvalidClaimsFromResponse: any ; getUserId: any ; signOut: any ; validateClaims: any }
Defined in node_modules/supertokens-website/lib/build/types.d.ts:77 Type declaration add: function add( input: { axiosInstance: any ; userContext: any } ) : void Defined in node_modules/supertokens-website/lib/build/types.d.ts:82 Parameters input: { axiosInstance: any ; userContext: any } axios: any user: any Returns void add: function add( input: { originalFetch: any ; userContext: any } ) : ( ( input: URL | RequestInfo , init?: RequestInit ) => Promise < Response > ) Defined in node_modules/supertokens-website/lib/build/types.d.ts:78 Parameters input: { originalFetch: any ; userContext: any } original: any user: any Returns ( ( input: URL | RequestInfo , init?: RequestInit ) => Promise < Response > ) ( input: URL | RequestInfo , init?: RequestInit ) : Promise < Response > Parameters input: URL | RequestInfo Optional init: RequestInit Returns Promise < Response > does: function does( input: { userContext: any } ) : Promise < boolean > Defined in node_modules/supertokens-website/lib/build/types.d.ts:92 Parameters input: { userContext: any } Returns Promise < boolean > get: function get( input: { userContext: any } ) : Promise < any > Defined in node_modules/supertokens-website/lib/build/types.d.ts:89 Parameters input: { userContext: any } Returns Promise < any > get: function Defined in node_modules/supertokens-website/lib/build/types.d.ts:108 Parameters get: function get( input: { response: { data: any } | Response ; userContext: any } ) : Promise < ClaimValidationError [] > Defined in node_modules/supertokens-website/lib/build/types.d.ts:98 Parameters input: { response: { data: any } | Response ; userContext: any } response: { data: any } | Response user: any get: function get( input: { userContext: any } ) : Promise < string > Defined in node_modules/supertokens-website/lib/build/types.d.ts:86 Parameters input: { userContext: any } Returns Promise < string > sign: function sign( input: { userContext: any } ) : Promise < void > Defined in node_modules/supertokens-website/lib/build/types.d.ts:95 Parameters input: { userContext: any } Returns Promise < void > validate: function Defined in node_modules/supertokens-website/lib/build/types.d.ts:104 Parameters Session Session< ValueType > : { getLastFetchedTime: any ; getValueFromPayload: any ; refresh: any }
Defined in node_modules/supertokens-website/lib/build/types.d.ts:140 Type Parameters Type declaration get: function get( payload: any , _userContext?: any ) : undefined | number Defined in node_modules/supertokens-website/lib/build/types.d.ts:143 Parameters payload: any Optional _userContext: any Returns undefined | number get: function get( payload: any , _userContext?: any ) : undefined | ValueType Defined in node_modules/supertokens-website/lib/build/types.d.ts:142 Parameters payload: any Optional _userContext: any Returns undefined | ValueType refresh: function refresh( userContext: any ) : Promise < void > Defined in node_modules/supertokens-website/lib/build/types.d.ts:141 Parameters Returns Promise < void > Session Session: LoadedSessionContext | { loading: true }
Variables Const SessionSession: FC < PropsWithChildren < SessionAuthProps & { userContext?: any } > > = SessionAPIWrapper.SessionAuth
Const SessionSession
Context
: Context < { invalidClaims
: ClaimValidationError [] ; loading
: false } & SessionContextUpdate & { isDefault
?: boolean } & { loading
: true } & { isDefault
?: boolean } > = ... Functions add add( axiosInstance: any , userContext?: any ) : void Parameters axiosInstance: any Optional userContext: any Returns void attempt attempt( ) : Promise < boolean > does does( input?: { userContext?: any } ) : Promise < boolean > Parameters Optional input: { userContext?: any } Optional user?: any Returns Promise < boolean > get get( input?: { userContext?: any } ) : Promise < any > Parameters Optional input: { userContext?: any } Optional user?: any Returns Promise < any > get get( input: { response: Response | { data: any } ; userContext: any } ) : Promise < ClaimValidationError [] > Parameters input: { response: Response | { data: any } ; userContext: any } response: Response | { data: any } user: any get get( input?: { userContext?: any } ) : Promise < string > Parameters Optional input: { userContext?: any } Optional user?: any Returns Promise < string > init init( config?: InputType ) : CreateRecipeFunction < unknown , unknown , unknown , any > Parameters Returns CreateRecipeFunction < unknown , unknown , unknown , any > sign sign( input?: { userContext?: any } ) : Promise < void > Parameters Optional input: { userContext?: any } Optional user?: any Returns Promise < void > use use< T > ( claim: SessionClaim < T > ) : { loading: true } | { doesSessionExist: boolean ; loading: false ; value: undefined | T } Type Parameters Parameters Returns { loading: true } | { doesSessionExist: boolean ; loading: false ; value: undefined | T } validate Parameters input: { userContext: any ; overrideGlobalClaimValidators?: any } user: any override?: function Legend Variable Function Function with type parameter Type alias Class Class with type parameter Settings Theme OS Light Dark
\ No newline at end of file
diff --git a/docs/modules/recipe_thirdparty.html b/docs/modules/recipe_thirdparty.html
index 0f0fbda58..7d282a4d6 100644
--- a/docs/modules/recipe_thirdparty.html
+++ b/docs/modules/recipe_thirdparty.html
@@ -1,4 +1,4 @@
-
recipe/thirdparty | supertokens-auth-react Type Aliases Get Get: AuthRecipeModuleGetRedirectionURLContext
On On: AuthRecipeModuleOnHandleEventContext | { action: "SUCCESS" ; isNewUser: boolean ; user: { email: string ; id: string } ; userContext: any }
PreAPIHook PreAPIHook: { action: PreAndPostAPIHookAction ; requestInit: RequestInit ; url: string ; userContext: any }
Type declaration action: PreAndPostAPIHookAction request: RequestInit url: string user: any Recipe Recipe: { generateStateToSendToOAuthProvider: any ; getAuthCodeFromURL: any ; getAuthErrorFromURL: any ; getAuthStateFromURL: any ; getAuthorisationURLFromBackend: any ; getAuthorisationURLWithQueryParamsAndSetState: any ; getStateAndOtherInfoFromStorage: any ; setStateAndOtherInfoToStorage: any ; signInAndUp: any ; verifyAndGetStateOrThrowError: any }
Defined in node_modules/supertokens-web-js/lib/build/recipe/thirdparty/types.d.ts:51 Type declaration generate: function generate( input: { userContext: any } ) : string Defined in node_modules/supertokens-web-js/lib/build/recipe/thirdparty/types.d.ts:151 User User: { email: string ; id: string ; thirdParty: { id: string ; userId: string } ; timeJoined: number }
Defined in node_modules/supertokens-web-js/lib/build/recipe/thirdparty/types.d.ts:42 Type declaration email: string id: string third: { id: string ; userId: string } time: number User User
Input
: { oAuthCallbackScreen
?: FeatureBaseConfig ; override
?: { components
?: ComponentOverrideMap ; functions
?: any } ; signInAndUpFeature
?: SignInAndUpFeatureUserInput } & AuthRecipeModuleUserInput < GetRedirectionURLContext , PreAndPostAPIHookAction , OnHandleEventContext > Variables Const SignSign: ComponentType < {} > = ...
Const SignSign: React.FC < SignInAndUpThemeProps > = ...
Functions Sign Sign( prop?: PropsWithChildren < { redirectOnSessionExists?: boolean ; userContext?: any } > ) : Element Parameters prop: PropsWithChildren < { redirectOnSessionExists?: boolean ; userContext?: any } > = {} Returns Element Sign Sign( prop?: any ) : Element Parameters Returns Element generate generate( input?: { userContext?: any } ) : string Parameters Optional input: { userContext?: any } Optional user?: any Returns string get get( input?: { userContext?: any } ) : string Parameters Optional input: { userContext?: any } Optional user?: any Returns string get get( input?: { userContext?: any } ) : undefined | string Parameters Optional input: { userContext?: any } Optional user?: any Returns undefined | string get get( input?: { userContext?: any } ) : string Parameters Optional input: { userContext?: any } Optional user?: any Returns string get get( input: { options?: RecipeFunctionOptions ; providerId: string ; userContext?: any } ) : Promise < { fetchResponse: Response ; status: "OK" ; url: string } > Parameters input: { options?: RecipeFunctionOptions ; providerId: string ; userContext?: any } Optional options?: RecipeFunctionOptions provider: string Optional user?: any Returns Promise < { fetchResponse: Response ; status: "OK" ; url: string } > get get( input: { authorisationURL: string ; options?: RecipeFunctionOptions ; providerClientId?: string ; providerId: string ; userContext?: any } ) : Promise < string > Parameters input: { authorisationURL: string ; options?: RecipeFunctionOptions ; providerClientId?: string ; providerId: string ; userContext?: any } authorisationURL: string Optional options?: RecipeFunctionOptions Optional provider?: string provider: string Optional user?: any Returns Promise < string > get get< CustomStateProperties > ( input?: { userContext?: any } ) : undefined | StateObject & CustomStateProperties Type Parameters Parameters Optional input: { userContext?: any } Optional user?: any Returns undefined | StateObject & CustomStateProperties init Parameters Returns CreateRecipeFunction < GetRedirectionURLContext , PreAndPostAPIHookAction , OnHandleEventContext , NormalisedConfig > redirect redirect( input: { thirdPartyId: string ; userContext?: any } ) : Promise < { status: "OK" | "ERROR" } > Parameters input: { thirdPartyId: string ; userContext?: any } third: string Optional user?: any Returns Promise < { status: "OK" | "ERROR" } > set set< CustomStateProperties > ( input: { state: StateObject & CustomStateProperties ; userContext?: any } ) : Promise < void > Type Parameters Parameters input: { state: StateObject & CustomStateProperties ; userContext?: any } state: StateObject & CustomStateProperties Optional user?: any Returns Promise < void > sign sign( input?: { options?: RecipeFunctionOptions ; userContext?: any } ) : Promise < { createdNewUser: boolean ; fetchResponse: Response ; status: "OK" ; user: User } | { fetchResponse: Response ; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } > Parameters Optional input: { options?: RecipeFunctionOptions ; userContext?: any } Optional options?: RecipeFunctionOptions Optional user?: any Returns Promise < { createdNewUser: boolean ; fetchResponse: Response ; status: "OK" ; user: User } | { fetchResponse: Response ; status: "NO_EMAIL_GIVEN_BY_PROVIDER" } > sign sign( input?: { userContext?: any } ) : Promise < void > Parameters Optional input: { userContext?: any } Optional user?: any Returns Promise < void > verify verify< CustomStateProperties > ( input: { stateFromAuthProvider: undefined | string ; stateObjectFromStorage: undefined | StateObject & CustomStateProperties ; userContext?: any } ) : Promise < StateObject & CustomStateProperties > Type Parameters Parameters input: { stateFromAuthProvider: undefined | string ; stateObjectFromStorage: undefined | StateObject & CustomStateProperties ; userContext?: any } state: undefined | string state: undefined | StateObject & CustomStateProperties Optional user?: any Returns Promise < StateObject & CustomStateProperties > Legend Variable Function Function with type parameter Type alias Class Class with type parameter Settings Theme OS Light Dark
\ No newline at end of file
diff --git a/docs/modules/recipe_thirdpartyemailpassword.html b/docs/modules/recipe_thirdpartyemailpassword.html
index 656c880f2..4ecf99a51 100644
--- a/docs/modules/recipe_thirdpartyemailpassword.html
+++ b/docs/modules/recipe_thirdpartyemailpassword.html
@@ -1,4 +1,4 @@
-
recipe/thirdpartyemailpassword | supertokens-auth-react Module recipe/thirdpartyemailpassword Legend Variable Function Function with type parameter Type alias Class Class with type parameter Settings Theme OS Light Dark
\ No newline at end of file
diff --git a/docs/modules/recipe_thirdpartypasswordless.html b/docs/modules/recipe_thirdpartypasswordless.html
index 04c7abdf7..f3079737c 100644
--- a/docs/modules/recipe_thirdpartypasswordless.html
+++ b/docs/modules/recipe_thirdpartypasswordless.html
@@ -1,4 +1,4 @@
-
recipe/thirdpartypasswordless | supertokens-auth-react Module recipe/thirdpartypasswordless References Sign Renames and re-exports __type Type Aliases Recipe Recipe: { clearPasswordlessLoginAttemptInfo: any ; consumePasswordlessCode: any ; createPasswordlessCode: any ; doesPasswordlessUserEmailExist: any ; doesPasswordlessUserPhoneNumberExist: any ; generateThirdPartyStateToSendToOAuthProvider: any ; getAuthorisationURLFromBackend: any ; getPasswordlessLinkCodeFromURL: any ; getPasswordlessLoginAttemptInfo: any ; getPasswordlessPreAuthSessionIdFromURL: any ; getThirdPartyAuthCodeFromURL: any ; getThirdPartyAuthErrorFromURL: any ; getThirdPartyAuthStateFromURL: any ; getThirdPartyAuthorisationURLWithQueryParamsAndSetState: any ; getThirdPartyStateAndOtherInfoFromStorage: any ; resendPasswordlessCode: any ; setPasswordlessLoginAttemptInfo: any ; setThirdPartyStateAndOtherInfoToStorage: any ; thirdPartySignInAndUp: any ; verifyAndGetThirdPartyStateOrThrowError: any }
Defined in node_modules/supertokens-web-js/lib/build/recipe/thirdpartypasswordless/types.d.ts:42 Type declaration clear: function clear( input: { userContext: any } ) : Promise < void > Defined in node_modules/supertokens-web-js/lib/build/recipe/thirdpartypasswordless/types.d.ts:392 User User
Input
: ( { contactMethod
: "EMAIL" ; signInUpFeature
?: SignInUpFeatureConfigInput ; validateEmailAddress
?: any } | { contactMethod
: "PHONE" ; signInUpFeature
?: SignInUpFeatureConfigInput & { defaultCountry
?: CountryCode } ; validatePhoneNumber
?: any } | { contactMethod
: "EMAIL_OR_PHONE" ; signInUpFeature
?: SignInUpFeatureConfigInput & { defaultCountry
?: CountryCode ; guessInternationPhoneNumberFromInputPhoneNumber
?: any } ; validateEmailAddress
?: any ; validatePhoneNumber
?: any } ) & { disablePasswordless
?: boolean ; linkClickedScreenFeature
?: PasswordlessFeatureBaseConfig ; oAuthCallbackScreen
?: FeatureBaseConfig ; override
?: { components
?: ComponentOverrideMap ; functions
?: any } } & AuthRecipeModuleUserInput < GetRedirectionURLContext , PreAndPostAPIHookAction , OnHandleEventContext > Legend Variable Function Function with type parameter Type alias Class Class with type parameter Settings Theme OS Light Dark
\ No newline at end of file
- Preparing search index...
- The search index is not available
supertokens-auth-reactModule recipe/emailpassword
Index
References
Classes
Type Aliases
Functions
References
Reset
Renames and re-exports __typeSign
Renames and re-exports __typeType Aliases
Get
On
PreAPIHook
Type declaration
action: PreAndPostAPIHookAction
request
url: string
user
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" }>
@@ -21,4 +21,4 @@{status: "OK", doesExist: boolean}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" | "RESET_PASSWORD_INVALID_TOKEN_ERROR" } | { fetchResponse: Response; formFields: { error: string; id: string }[]; status: "FIELD_ERROR" }>
-{status: "OK"}if successfullUser
Functions
Reset
Parameters
Optional prop: any
Returns Element
Sign
Parameters
prop: PropsWithChildren<{ redirectOnSessionExists?: boolean; userContext?: any }> = {}
Returns Element
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
init
Parameters
Optional config: UserInput
Returns CreateRecipeFunction<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext, NormalisedConfig>
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; 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" }>
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" }>
submit
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" }>
Generated using TypeDoc