Options
All
  • Public
  • Public/Protected
  • All
Menu

These are the SDK reference docs. If you’re looking for docs to implement SuperTokens, you might want to check out the User Guides

Module recipe/session

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

InputType

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

Type declaration

  • Optional apiBasePath?: string
  • Optional apiDomain?: string
  • Optional autoAddCredentials?: boolean
  • Optional cookieDomain?: string
  • Optional isInIframe?: boolean
  • Optional override?: { functions?: any }
  • Optional sessionExpiredStatusCode?: number
  • Optional sessionScope?: string
  • onHandleEvent?:function
    • onHandleEvent(event: RecipeEvent): void
  • 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 }>

SessionContextType

SessionContextType: { doesSessionExist: boolean; jwtPayload: any; userId: string }

Type declaration

  • doesSessionExist: boolean
  • jwtPayload: any
  • userId: string

Variables

SessionAuth

SessionAuth: FC<Props> = SessionAPIWrapper.SessionAuth

SessionContext

SessionContext: Context<SessionContextType> = ...

Functions

Const addAxiosInterceptors

  • addAxiosInterceptors(axiosInstance: any): void

Const attemptRefreshingSession

  • attemptRefreshingSession(): Promise<boolean>

Const doesSessionExist

  • doesSessionExist(): Promise<boolean>

Const getJWTPayloadSecurely

  • getJWTPayloadSecurely(): Promise<any>

Const getUserId

  • getUserId(): Promise<string>

Const init

  • init(config?: InputType): CreateRecipeFunction<unknown, unknown, unknown, any>

Const signOut

  • signOut(): Promise<void>

Const useSessionContext

Generated using TypeDoc