Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • default

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static ComponentsOverrideProvider

ComponentsOverrideProvider: FC<PropsWithChildren<{ components: ComponentOverrideMap }>> = RecipeComponentsOverrideContextProvider

Methods

Static getLoginChallengeInfo

  • getLoginChallengeInfo(input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext?: any }): Promise<{ fetchResponse: Response; info: LoginInfo; status: "OK" }>

  • Returns information about an OAuth login in progress

    throws

    STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"

    Parameters

    • input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext?: any }
      • loginChallenge: string
      • Optional options?: RecipeFunctionOptions
      • Optional userContext?: any

    Returns Promise<{ fetchResponse: Response; info: LoginInfo; status: "OK" }>

    {status: "OK", info: LoginInfo}

Static getRedirectURLToContinueOAuthFlow

  • getRedirectURLToContinueOAuthFlow(input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext?: any }): Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>

  • Accepts the OAuth2 Login request and returns the redirect URL to continue the OAuth flow.

    throws

    STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"

    Parameters

    • input: { loginChallenge: string; options?: RecipeFunctionOptions; userContext?: any }
      • loginChallenge: string
      • Optional options?: RecipeFunctionOptions
      • Optional userContext?: any

    Returns Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>

    {status: "OK", frontendRedirectTo: string}

Static init

Static logOut

  • logOut(input: { logoutChallenge: string; options?: RecipeFunctionOptions; userContext?: any }): Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>

  • Accepts the OAuth2 Logout request, clears the SuperTokens session and returns post logout redirect URL.

    throws

    STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"

    Parameters

    • input: { logoutChallenge: string; options?: RecipeFunctionOptions; userContext?: any }
      • logoutChallenge: string
      • Optional options?: RecipeFunctionOptions
      • Optional userContext?: any

    Returns Promise<{ fetchResponse: Response; frontendRedirectTo: string; status: "OK" }>

    {status: "OK", frontendRedirectTo: string}

Generated using TypeDoc