supertokens-react-native

Index

Classes

default

Type aliases

Functions

Type aliases

InputType

InputType: { apiBasePath?: string; apiDomain: string; autoAddCredentials?: boolean; enableDebugLogs?: boolean; maxRetryAttemptsForSessionRefresh?: number; onHandleEvent?: EventHandler; override?: { functions?: any }; sessionExpiredStatusCode?: number; sessionTokenBackendDomain?: string; tokenTransferMethod?: "cookie" | "header"; preAPIHook?: any }

Type declaration

Optional apiBasePath?: string
apiDomain: string
Optional autoAddCredentials?: boolean
Optional enableDebugLogs?: boolean
Optional maxRetryAttemptsForSessionRefresh?: number

This specifies the maximum number of times the interceptor will attempt to refresh the session when a 401 Unauthorized response is received. If the number of retries exceeds this limit, no further attempts will be made to refresh the session, and and an error will be thrown.
Optional onHandleEvent?: EventHandler
Optional override?: { functions?: any }
- functions?:function
  - functions(originalImplementation: RecipeInterface, builder?: OverrideableBuilder<RecipeInterface>): RecipeInterface
  - - Defined in lib/ts/types.ts:51
    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 }>
- - Defined in lib/ts/types.ts:44
  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; shouldDoInterceptionBasedOnUrl: any; signOut: any }

Type declaration

addAxiosInterceptors:function
- addAxiosInterceptors(axiosInstance: any, config: NormalisedInputType): void
- - Defined in lib/ts/types.ts:88
  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> }
- - Defined in lib/ts/types.ts:86
  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>
- - Defined in lib/ts/types.ts:94
  Parameters
  - config: NormalisedInputType
  Returns Promise<boolean>
getAccessTokenPayloadSecurely:function
- getAccessTokenPayloadSecurely(config: NormalisedInputType): Promise<any>
- - Defined in lib/ts/types.ts:92
  Parameters
  - config: NormalisedInputType
  Returns Promise<any>
getUserId:function
- getUserId(config: NormalisedInputType): Promise<string>
- - Defined in lib/ts/types.ts:90
  Parameters
  - config: NormalisedInputType
  Returns Promise<string>
shouldDoInterceptionBasedOnUrl:function
- shouldDoInterceptionBasedOnUrl(toCheckUrl: string, apiDomain: string, sessionTokenBackendDomain: undefined | string): boolean
- - Defined in lib/ts/types.ts:98
  Parameters
  - toCheckUrl: string
  - apiDomain: string
  - sessionTokenBackendDomain: undefined | string
  Returns boolean
signOut:function
- signOut(config: NormalisedInputType): Promise<void>
- - Defined in lib/ts/types.ts:96
  Parameters
  - config: NormalisedInputType
  Returns Promise<void>

Functions

addAxiosInterceptors

addAxiosInterceptors(axiosInstance: any): void

- Defined in lib/ts/index.ts:99
Parameters
- axiosInstance: any
Returns void

attemptRefreshingSession

attemptRefreshingSession(): Promise<boolean>

- Defined in lib/ts/index.ts:97
Returns Promise<boolean>

doesSessionExist

doesSessionExist(): Promise<boolean>

- Defined in lib/ts/index.ts:98
Returns Promise<boolean>

getAccessToken

getAccessToken(): Promise<undefined | string>

- Defined in lib/ts/index.ts:101
Returns Promise<undefined | string>

getAccessTokenPayloadSecurely

getAccessTokenPayloadSecurely(): Promise<any>

- Defined in lib/ts/index.ts:96
Returns Promise<any>

getUserId

getUserId(): Promise<string>

- Defined in lib/ts/index.ts:95
Returns Promise<string>

init

init(options: InputType): void

- Defined in lib/ts/index.ts:94
Parameters
- options: InputType
Returns void

signOut

signOut(): Promise<void>

- Defined in lib/ts/index.ts:100
Returns Promise<void>

Index

Classes

Type aliases

Functions

Type aliases

InputType

Type declaration

Optional apiBasePath?: string

apiDomain: string

Optional autoAddCredentials?: boolean

Optional enableDebugLogs?: boolean

Optional maxRetryAttemptsForSessionRefresh?: number

Optional onHandleEvent?: EventHandler

Optional override?: { functions?: any }

functions?:function

Parameters

originalImplementation: RecipeInterface

Optional builder: OverrideableBuilder<RecipeInterface>

Returns RecipeInterface

Optional sessionExpiredStatusCode?: number

Optional sessionTokenBackendDomain?: string

Optional tokenTransferMethod?: "cookie" | "header"

preAPIHook?:function

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

Type declaration

addAxiosInterceptors:function

Parameters

axiosInstance: any

config: NormalisedInputType

Returns void

addFetchInterceptorsAndReturnModifiedFetch:function

Parameters

originalFetch: any

config: NormalisedInputType

Returns { (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

Parameters

config: NormalisedInputType

Returns Promise<boolean>

getAccessTokenPayloadSecurely:function

Parameters

config: NormalisedInputType

Returns Promise<any>

getUserId:function

Parameters

config: NormalisedInputType

Returns Promise<string>

shouldDoInterceptionBasedOnUrl:function

Parameters

toCheckUrl: string

apiDomain: string

sessionTokenBackendDomain: undefined | string

Returns boolean

signOut:function

Parameters

config: NormalisedInputType

Returns Promise<void>

Functions

addAxiosInterceptors

Parameters

axiosInstance: any

Returns void

attemptRefreshingSession

Returns Promise<boolean>

doesSessionExist

Returns Promise<boolean>