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

  • fetchAndSetClaim<T>(claim: SessionClaim<T>, userContext?: any): Promise<void>
  • getAccessToken(userContext?: any): string
  • getAccessTokenPayload(userContext?: any): any
  • getClaimValue<T>(claim: SessionClaim<T>, userContext?: any): Promise<undefined | T>
  • getExpiry(userContext?: any): Promise<number>
  • getHandle(userContext?: any): string
  • getSessionData(userContext?: any): Promise<any>
  • 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>
  • updateAccessTokenPayload(newAccessTokenPayload: any, userContext?: any): Promise<void>
  • deprecated

    Use mergeIntoAccessTokenPayload instead

    Parameters

    • newAccessTokenPayload: any
    • Optional userContext: any

    Returns Promise<void>

  • updateSessionData(newSessionData: any, userContext?: any): Promise<any>

Generated using TypeDoc