Options
All
  • Public
  • Public/Protected
  • All
Menu

supertokens-react-native

Index

Type aliases

InputType

InputType: { apiBasePath?: string; apiDomain: string; autoAddCredentials?: boolean; cookieDomain?: string; onHandleEvent?: EventHandler; override?: { functions?: any }; sessionExpiredStatusCode?: number; preAPIHook?: any }

Type declaration

  • Optional apiBasePath?: string
  • apiDomain: string
  • Optional autoAddCredentials?: boolean
  • Optional cookieDomain?: string
  • Optional onHandleEvent?: EventHandler
  • Optional override?: { functions?: any }
  • Optional sessionExpiredStatusCode?: number
  • 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 }>

RecipeInterface

RecipeInterface: { addAxiosInterceptors: any; addFetchInterceptorsAndReturnModifiedFetch: any; doesSessionExist: any; getAccessTokenPayloadSecurely: any; getUserId: any; signOut: any }

Type declaration

  • 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>
  • getUserId:function
    • getUserId(config: NormalisedInputType): Promise<string>
  • signOut:function
    • signOut(config: NormalisedInputType): Promise<void>

Functions

addAxiosInterceptors

  • addAxiosInterceptors(axiosInstance: any): void

attemptRefreshingSession

  • attemptRefreshingSession(): Promise<boolean>

doesSessionExist

  • doesSessionExist(): Promise<boolean>

getAccessTokenPayloadSecurely

  • getAccessTokenPayloadSecurely(): Promise<any>

getUserId

  • getUserId(): Promise<string>

init

signOut

  • signOut(): Promise<void>

Generated using TypeDoc