From cc94bf12681db90368ed6cf96bb40eff4838bdd1 Mon Sep 17 00:00:00 2001 From: rishabhpoddar Date: Sat, 15 Jun 2024 12:45:46 +0530 Subject: [PATCH] adding dev-v5.1.1 tag to this commit to ensure building --- docs/classes/default.html | 2 +- docs/modules.html | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/classes/default.html b/docs/classes/default.html index bf5a793..9e0966f 100644 --- a/docs/classes/default.html +++ b/docs/classes/default.html @@ -1 +1 @@ -default | supertokens-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • default

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Private axiosInterceptorQueue

axiosInterceptorQueue: (() => void)[] = []

Methods

Static addAxiosInterceptors

  • addAxiosInterceptors(axiosInstance: any): void

Static attemptRefreshingSession

  • attemptRefreshingSession(): Promise<boolean>

Static doesSessionExist

  • doesSessionExist(): Promise<boolean>

Static getAccessToken

  • getAccessToken(): Promise<undefined | string>

Static getAccessTokenPayloadSecurely

  • getAccessTokenPayloadSecurely(): Promise<any>

Static getUserId

  • getUserId(): Promise<string>

Static init

Static signOut

  • signOut(): Promise<void>

Generated using TypeDoc

\ No newline at end of file +default | supertokens-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default

Hierarchy

  • default

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Private axiosInterceptorQueue

axiosInterceptorQueue: (() => void)[] = []

Methods

Static addAxiosInterceptors

  • addAxiosInterceptors(axiosInstance: any): void

Static attemptRefreshingSession

  • attemptRefreshingSession(): Promise<boolean>

Static doesSessionExist

  • doesSessionExist(): Promise<boolean>

Static getAccessToken

  • getAccessToken(): Promise<undefined | string>

Static getAccessTokenPayloadSecurely

  • getAccessTokenPayloadSecurely(): Promise<any>

Static getUserId

  • getUserId(): Promise<string>

Static init

Static signOut

  • signOut(): Promise<void>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index f405744..3f52a1f 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,6 +1,6 @@ -supertokens-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

supertokens-react-native

Index

Classes

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
    +supertokens-react-native
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    supertokens-react-native

    Index

    Classes

    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 }
    • 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 }>

    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

      • 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>
    • 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>

    Functions

    addAxiosInterceptors

    • addAxiosInterceptors(axiosInstance: any): void

    attemptRefreshingSession

    • attemptRefreshingSession(): Promise<boolean>

    doesSessionExist

    • doesSessionExist(): Promise<boolean>

    getAccessToken

    • getAccessToken(): Promise<undefined | string>

    getAccessTokenPayloadSecurely

    • getAccessTokenPayloadSecurely(): Promise<any>

    getUserId

    • getUserId(): Promise<string>

    init

    signOut

    • signOut(): Promise<void>

    Legend

    • Constructor
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file +
  • Optional onHandleEvent?: EventHandler
  • Optional override?: { functions?: any }
  • 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 }>

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

    • 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>
  • 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>

Functions

addAxiosInterceptors

  • addAxiosInterceptors(axiosInstance: any): void

attemptRefreshingSession

  • attemptRefreshingSession(): Promise<boolean>

doesSessionExist

  • doesSessionExist(): Promise<boolean>

getAccessToken

  • getAccessToken(): Promise<undefined | string>

getAccessTokenPayloadSecurely

  • getAccessTokenPayloadSecurely(): Promise<any>

getUserId

  • getUserId(): Promise<string>

init

signOut

  • signOut(): Promise<void>

Generated using TypeDoc

\ No newline at end of file