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

Hierarchy

  • SessionContainer

Index

Methods

  • attachToRequestResponse(reqResInfo: ReqResInfo, userContext?: any): void | Promise<void>
  • fetchAndSetClaim<T>(claim: SessionClaim<T>, userContext?: any): Promise<void>
  • getAccessToken(userContext?: any): string
  • getAccessTokenPayload(userContext?: any): any
  • getAllSessionTokensDangerously(): { accessAndFrontTokenUpdated: boolean; accessToken: string; antiCsrfToken: undefined | string; frontToken: string; refreshToken: undefined | string }
  • Returns { accessAndFrontTokenUpdated: boolean; accessToken: string; antiCsrfToken: undefined | string; frontToken: string; refreshToken: undefined | string }

    • accessAndFrontTokenUpdated: boolean
    • accessToken: string
    • antiCsrfToken: undefined | string
    • frontToken: string
    • refreshToken: undefined | string
  • getClaimValue<T>(claim: SessionClaim<T>, userContext?: any): Promise<undefined | T>
  • getExpiry(userContext?: any): Promise<number>
  • getHandle(userContext?: any): string
  • getSessionDataFromDatabase(userContext?: any): Promise<any>
  • getTenantId(userContext?: any): string
  • getTimeCreated(userContext?: any): Promise<number>
  • getUserId(userContext?: any): string
  • mergeIntoAccessTokenPayload(accessTokenPayloadUpdate: JSONObject, userContext?: any): Promise<void>
  • removeClaim(claim: SessionClaim<any>, userContext?: any): Promise<void>
  • revokeSession(userContext?: any): Promise<void>
  • setClaimValue<T>(claim: SessionClaim<T>, value: T, userContext?: any): Promise<void>
  • updateSessionDataInDatabase(newSessionData: any, userContext?: any): Promise<any>

Generated using TypeDoc