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

Class default

Hierarchy

  • default

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static SessionAuth

SessionAuth: FC<PropsWithChildren<SessionAuthProps & { userContext?: any }>> = SessionAuthWrapper

Static useClaimValue

useClaimValue: (<T>(claim: SessionClaim<T>) => { loading: true } | { doesSessionExist: boolean; loading: false; value: undefined | T }) = useClaimValueFunc

Type declaration

    • <T>(claim: SessionClaim<T>): { loading: true } | { doesSessionExist: boolean; loading: false; value: undefined | T }

    • Type Parameters

      • T

      Parameters

      Returns { loading: true } | { doesSessionExist: boolean; loading: false; value: undefined | T }

Static useSessionContext

useSessionContext: (() => SessionContextType) = useSessionContextFunc

Type declaration

Methods

Static addAxiosInterceptors

  • addAxiosInterceptors(axiosInstance: any, userContext?: any): void

Static attemptRefreshingSession

  • attemptRefreshingSession(): Promise<boolean>

Static doesSessionExist

  • doesSessionExist(input?: { userContext?: any }): Promise<boolean>

Static getAccessTokenPayloadSecurely

  • getAccessTokenPayloadSecurely(input?: { userContext?: any }): Promise<any>

Static getInvalidClaimsFromResponse

  • getInvalidClaimsFromResponse(input: { response: Response | { data: any }; userContext: any }): Promise<ClaimValidationError[]>

Static getUserId

  • getUserId(input?: { userContext?: any }): Promise<string>

Static init

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

Static signOut

  • signOut(input?: { userContext?: any }): Promise<void>

Static validateClaims

Generated using TypeDoc