supertokens-node
    Preparing search index...

    Interface SessionContainer

    interface SessionContainer {
        assertClaims(
            claimValidators: SessionClaimValidator[],
            userContext?: Record<string, any>,
        ): Promise<void>;
        attachToRequestResponse(
            reqResInfo: ReqResInfo,
            userContext?: Record<string, any>,
        ): void | Promise<void>;
        fetchAndSetClaim<T>(
            claim: SessionClaim<T>,
            userContext?: Record<string, any>,
        ): Promise<void>;
        getAccessToken(userContext?: Record<string, any>): string;
        getAccessTokenPayload(userContext?: Record<string, any>): any;
        getAllSessionTokensDangerously(): {
            accessAndFrontTokenUpdated: boolean;
            accessToken: string;
            antiCsrfToken: undefined
            | string;
            frontToken: string;
            refreshToken: undefined | string;
        };
        getClaimValue<T>(
            claim: SessionClaim<T>,
            userContext?: Record<string, any>,
        ): Promise<undefined | T>;
        getExpiry(userContext?: Record<string, any>): Promise<number>;
        getHandle(userContext?: Record<string, any>): string;
        getRecipeUserId(userContext?: Record<string, any>): RecipeUserId;
        getSessionDataFromDatabase(userContext?: Record<string, any>): Promise<any>;
        getTenantId(userContext?: Record<string, any>): string;
        getTimeCreated(userContext?: Record<string, any>): Promise<number>;
        getUserId(userContext?: Record<string, any>): string;
        mergeIntoAccessTokenPayload(
            accessTokenPayloadUpdate: JSONObject,
            userContext?: Record<string, any>,
        ): Promise<void>;
        removeClaim(
            claim: SessionClaim<any>,
            userContext?: Record<string, any>,
        ): Promise<void>;
        revokeSession(userContext?: Record<string, any>): Promise<void>;
        setClaimValue<T>(
            claim: SessionClaim<T>,
            value: T,
            userContext?: Record<string, any>,
        ): Promise<void>;
        updateSessionDataInDatabase(
            newSessionData: any,
            userContext?: Record<string, any>,
        ): Promise<any>;
    }
    Index

    Methods

    • Parameters

      • reqResInfo: ReqResInfo
      • OptionaluserContext: Record<string, any>

      Returns void | Promise<void>

    • Type Parameters

      • T

      Parameters

      • claim: SessionClaim<T>
      • OptionaluserContext: Record<string, any>

      Returns Promise<void>

    • Returns {
          accessAndFrontTokenUpdated: boolean;
          accessToken: string;
          antiCsrfToken: undefined | string;
          frontToken: string;
          refreshToken: undefined | string;
      }

    • Type Parameters

      • T

      Parameters

      • claim: SessionClaim<T>
      • OptionaluserContext: Record<string, any>

      Returns Promise<undefined | T>

    • Parameters

      • OptionaluserContext: Record<string, any>

      Returns Promise<number>

    • Parameters

      • OptionaluserContext: Record<string, any>

      Returns Promise<any>

    • Parameters

      • OptionaluserContext: Record<string, any>

      Returns Promise<number>

    • Parameters

      • accessTokenPayloadUpdate: JSONObject
      • OptionaluserContext: Record<string, any>

      Returns Promise<void>

    • Parameters

      • claim: SessionClaim<any>
      • OptionaluserContext: Record<string, any>

      Returns Promise<void>

    • Parameters

      • OptionaluserContext: Record<string, any>

      Returns Promise<void>

    • Type Parameters

      • T

      Parameters

      • claim: SessionClaim<T>
      • value: T
      • OptionaluserContext: Record<string, any>

      Returns Promise<void>

    • Parameters

      • newSessionData: any
      • OptionaluserContext: Record<string, any>

      Returns Promise<any>