supertokens-react-native

Optional apiBasePath?: string

apiDomain: string

Optional autoAddCredentials?: boolean

Optional onHandleEvent?: EventHandler

Optional override?: { functions?: any }

• functions?:function

  • functions(originalImplementation: RecipeInterface, builder?: OverrideableBuilder<RecipeInterface>): RecipeInterface

  • Parameters

    • originalImplementation: RecipeInterface

    • Optional builder: OverrideableBuilder<RecipeInterface>

    Returns RecipeInterface

Optional sessionExpiredStatusCode?: number

Optional sessionTokenBackendDomain?: string

Optional tokenTransferMethod?: "cookie" | "header"

preAPIHook?:function

• preAPIHook(context: { action: "SIGN_OUT" | "REFRESH_SESSION"; requestInit: RequestInit; url: string }): Promise<{ requestInit: RequestInit; url: string }>

• Parameters

  • context: { action: "SIGN_OUT" | "REFRESH_SESSION"; requestInit: RequestInit; url: string }

    • action: "SIGN_OUT" | "REFRESH_SESSION"

    • requestInit: RequestInit

    • url: string

  Returns Promise<{ requestInit: RequestInit; url: string }>

addAxiosInterceptors:function

• addAxiosInterceptors(axiosInstance: any, config: NormalisedInputType): void

• Parameters

  • axiosInstance: any

  • config: NormalisedInputType

  Returns void

addFetchInterceptorsAndReturnModifiedFetch:function

• addFetchInterceptorsAndReturnModifiedFetch(originalFetch: any, config: NormalisedInputType): { (input: RequestInfo, init?: RequestInit): Promise<Response>; (input: RequestInfo, init?: RequestInit): Promise<Response> }

• Parameters

  • originalFetch: any

  • config: NormalisedInputType

  Returns { (input: RequestInfo, init?: RequestInit): Promise<Response>; (input: RequestInfo, init?: RequestInit): Promise<Response> }

  • • (input: RequestInfo, init?: RequestInit): Promise<Response>
    • (input: RequestInfo, init?: RequestInit): Promise<Response>

    • Parameters

      • input: RequestInfo

      • Optional init: RequestInit

      Returns Promise<Response>

    • Parameters

      • input: RequestInfo

      • Optional init: RequestInit

      Returns Promise<Response>

doesSessionExist:function

• doesSessionExist(config: NormalisedInputType): Promise<boolean>

• Parameters

  • config: NormalisedInputType

  Returns Promise<boolean>

getAccessTokenPayloadSecurely:function

• getAccessTokenPayloadSecurely(config: NormalisedInputType): Promise<any>

• Parameters

  • config: NormalisedInputType

  Returns Promise<any>

getUserId:function

• getUserId(config: NormalisedInputType): Promise<string>

• Parameters

  • config: NormalisedInputType

  Returns Promise<string>

shouldDoInterceptionBasedOnUrl:function

• shouldDoInterceptionBasedOnUrl(toCheckUrl: string, apiDomain: string, sessionTokenBackendDomain: undefined | string): boolean

• Parameters

  • toCheckUrl: string

  • apiDomain: string

  • sessionTokenBackendDomain: undefined | string

  Returns boolean

signOut:function

• signOut(config: NormalisedInputType): Promise<void>

• Parameters

  • config: NormalisedInputType

  Returns Promise<void>