Skip to content
SuperTokens Docs
Esc
↑↓navigate↵open⌘Jpreview
Dashboard
On this page

supertokens-web-js/recipe/session

References documentation for the supertokens-web-js/recipe/session package

Classes

BooleanClaim

Defined in: node_modules/supertokens-website/lib/build/claims/booleanClaim.d.ts

Extends

Extended by

Constructors

Constructor
new BooleanClaim(config): BooleanClaim;

Defined in: node_modules/supertokens-website/lib/build/claims/booleanClaim.d.ts

Parameters
Parameter Type
config PrimitiveClaimConfig
Returns

BooleanClaim

Overrides

PrimitiveClaim.constructor

Properties

Property Modifier Type Overrides Inherited from Defined in
defaultMaxAgeInSeconds readonly number - PrimitiveClaim.defaultMaxAgeInSeconds node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts
id readonly string - PrimitiveClaim.id node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts
refresh readonly (userContext) => Promise<void> - PrimitiveClaim.refresh node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts
validators public object & BooleanValidators PrimitiveClaim.validators - node_modules/supertokens-website/lib/build/claims/booleanClaim.d.ts

Methods

getLastFetchedTime()
getLastFetchedTime(payload, _userContext?): number;

Defined in: node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts

Parameters
Parameter Type
payload any
_userContext? any
Returns

number

Inherited from

PrimitiveClaim.getLastFetchedTime

getValueFromPayload()
getValueFromPayload(payload, _userContext?): boolean;

Defined in: node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts

Parameters
Parameter Type
payload any
_userContext? any
Returns

boolean

Inherited from

PrimitiveClaim.getValueFromPayload

default

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Constructors

Constructor
new default(): default;
Returns

default

Methods

addAxiosInterceptors()
static addAxiosInterceptors(axiosInstance, userContext?): void;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters
Parameter Type
axiosInstance any
userContext? any
Returns

void

Deprecated
attemptRefreshingSession()
static attemptRefreshingSession(): Promise<boolean>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Returns

Promise<boolean>

doesSessionExist()
static doesSessionExist(input?): Promise<boolean>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters
Parameter Type
input? { userContext?: any; }
input.userContext? any
Returns

Promise<boolean>

getAccessToken()
static getAccessToken(input?): Promise<string>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters
Parameter Type
input? { userContext?: any; }
input.userContext? any
Returns

Promise<string>

getAccessTokenPayloadSecurely()
static getAccessTokenPayloadSecurely(input?): Promise<any>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters
Parameter Type
input? { userContext?: any; }
input.userContext? any
Returns

Promise<any>

getClaimValue()
static getClaimValue<T>(input): Promise<T>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Type Parameters
Type Parameter
T
Parameters
Parameter Type
input { claim: SessionClaim<T>; userContext?: any; }
input.claim SessionClaim<T>
input.userContext? any
Returns

Promise<T>

getInvalidClaimsFromResponse()
static getInvalidClaimsFromResponse(input): Promise<ClaimValidationError[]>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters
Parameter Type
input { response: | Response | { data: any; }; userContext?: any; }
input.response | Response | { data: any; }
input.userContext? any
Returns

Promise<ClaimValidationError[]>

getUserId()
static getUserId(input?): Promise<string>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters
Parameter Type
input? { userContext?: any; }
input.userContext? any
Returns

Promise<string>

init()
static init(config?): CreateRecipeFunction<unknown>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters
Parameter Type
config? UserInput
Returns

CreateRecipeFunction<unknown>

signOut()
static signOut(input?): Promise<void>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters
Parameter Type
input? { userContext?: any; }
input.userContext? any
Returns

Promise<void>

validateClaims()
static validateClaims(input?): 
  | ClaimValidationError[]
| Promise<ClaimValidationError[]>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters
Parameter Type
input? { overrideGlobalClaimValidators?: (globalClaimValidators, userContext) => SessionClaimValidator[]; userContext?: any; }
input.overrideGlobalClaimValidators? (globalClaimValidators, userContext) => SessionClaimValidator[]
input.userContext? any
Returns

| ClaimValidationError[] | Promise<ClaimValidationError[]>

PrimitiveArrayClaim<ValueType>

Defined in: node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts

Type Parameters

Type Parameter
ValueType

Constructors

Constructor
new PrimitiveArrayClaim<ValueType>(config): PrimitiveArrayClaim<ValueType>;

Defined in: node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts

Parameters
Parameter Type
config PrimitiveArrayClaimConfig
Returns

PrimitiveArrayClaim<ValueType>

Properties

Property Modifier Type Defined in
defaultMaxAgeInSeconds readonly number node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts
id readonly string node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts
refresh readonly (userContext) => Promise<void> node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts
validators public object node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts
validators.excludes public (val, maxAgeInSeconds?, id?) => SessionClaimValidator node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts
validators.excludesAll public (val, maxAgeInSeconds?, id?) => SessionClaimValidator node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts
validators.includes public (val, maxAgeInSeconds?, id?) => SessionClaimValidator node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts
validators.includesAll public (val, maxAgeInSeconds?, id?) => SessionClaimValidator node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts
validators.includesAny public (val, maxAgeInSeconds?, id?) => SessionClaimValidator node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts

Methods

getLastFetchedTime()
getLastFetchedTime(payload, _userContext?): number;

Defined in: node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts

Parameters
Parameter Type
payload any
_userContext? any
Returns

number

getValueFromPayload()
getValueFromPayload(payload, _userContext?): ValueType[];

Defined in: node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts

Parameters
Parameter Type
payload any
_userContext? any
Returns

ValueType[]

PrimitiveClaim<ValueType>

Defined in: node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts

Extended by

Type Parameters

Type Parameter
ValueType

Constructors

Constructor
new PrimitiveClaim<ValueType>(config): PrimitiveClaim<ValueType>;

Defined in: node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts

Parameters
Parameter Type
config PrimitiveClaimConfig
Returns

PrimitiveClaim<ValueType>

Properties

Property Modifier Type Defined in
defaultMaxAgeInSeconds readonly number node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts
id readonly string node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts
refresh readonly (userContext) => Promise<void> node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts
validators public object node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts
validators.hasValue public (val, maxAgeInSeconds?, id?) => SessionClaimValidator node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts

Methods

getLastFetchedTime()
getLastFetchedTime(payload, _userContext?): number;

Defined in: node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts

Parameters
Parameter Type
payload any
_userContext? any
Returns

number

getValueFromPayload()
getValueFromPayload(payload, _userContext?): ValueType;

Defined in: node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts

Parameters
Parameter Type
payload any
_userContext? any
Returns

ValueType

Type Aliases

ClaimValidationError

type ClaimValidationError = object;

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Properties

Property Type Defined in
id string node_modules/supertokens-website/lib/build/types.d.ts
reason? any node_modules/supertokens-website/lib/build/types.d.ts

ClaimValidationResult

type ClaimValidationResult = 
  | {
  isValid: true;
}
  | {
  isValid: false;
  reason?: any;
};

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

PrimitiveArrayClaimConfig

type PrimitiveArrayClaimConfig = object;

Defined in: node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts

Properties

Property Type Defined in
defaultMaxAgeInSeconds? number node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts
id string node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts
refresh (userContext?) => Promise<void> node_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts

PrimitiveClaimConfig

type PrimitiveClaimConfig = object;

Defined in: node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts

Properties

Property Type Defined in
defaultMaxAgeInSeconds? number node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts
id string node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts
refresh (userContext?) => Promise<void> node_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts

RecipeInterface

type RecipeInterface = object;

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Properties

Property Type Defined in
addAxiosInterceptors (input) => void node_modules/supertokens-website/lib/build/types.d.ts
addFetchInterceptorsAndReturnModifiedFetch (input) => typeof fetch node_modules/supertokens-website/lib/build/types.d.ts
addXMLHttpRequestInterceptor (input) => void node_modules/supertokens-website/lib/build/types.d.ts
doesSessionExist (input) => Promise<boolean> node_modules/supertokens-website/lib/build/types.d.ts
getAccessTokenPayloadSecurely (input) => Promise<any> node_modules/supertokens-website/lib/build/types.d.ts
getUserId (input) => Promise<string> node_modules/supertokens-website/lib/build/types.d.ts
signOut (input) => Promise<void> node_modules/supertokens-website/lib/build/types.d.ts
validateClaims (input) => Promise<ClaimValidationError[]> node_modules/supertokens-website/lib/build/types.d.ts

Methods

calculateClockSkewInMillis()
calculateClockSkewInMillis(params): number;

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Parameters
Parameter Type
params { accessTokenPayload: any; responseHeaders: Headers; }
params.accessTokenPayload any
params.responseHeaders Headers
Returns

number

getGlobalClaimValidators()
getGlobalClaimValidators(input): SessionClaimValidator[];

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Parameters
Parameter Type
input { claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]; userContext: any; }
input.claimValidatorsAddedByOtherRecipes SessionClaimValidator[]
input.userContext any
Returns

SessionClaimValidator[]

getInvalidClaimsFromResponse()
getInvalidClaimsFromResponse(input): Promise<ClaimValidationError[]>;

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Parameters
Parameter Type
input { response: | { data: any; } | Response; userContext: any; }
input.response | { data: any; } | Response
input.userContext any
Returns

Promise<ClaimValidationError[]>

shouldDoInterceptionBasedOnUrl()
shouldDoInterceptionBasedOnUrl(
   toCheckUrl, 
   apiDomain, 
   sessionTokenBackendDomain): boolean;

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Parameters
Parameter Type
toCheckUrl string
apiDomain string
sessionTokenBackendDomain string
Returns

boolean

SessionClaim<ValueType>

type SessionClaim<ValueType> = object;

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Type Parameters

Type Parameter
ValueType

Methods

getLastFetchedTime()
getLastFetchedTime(payload, _userContext?): number;

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Parameters
Parameter Type
payload any
_userContext? any
Returns

number

getValueFromPayload()
getValueFromPayload(payload, _userContext?): ValueType;

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Parameters
Parameter Type
payload any
_userContext? any
Returns

ValueType

refresh()
refresh(userContext): Promise<void>;

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Parameters
Parameter Type
userContext any
Returns

Promise<void>

SessionClaimValidator

type SessionClaimValidator = object;

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Properties

Property Modifier Type Defined in
id readonly string node_modules/supertokens-website/lib/build/types.d.ts

Methods

refresh()
refresh(userContext): Promise<void>;

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Makes an API call that will refresh the claim in the token.

Parameters
Parameter Type
userContext any
Returns

Promise<void>

shouldRefresh()
shouldRefresh(accessTokenPayload, userContext): boolean | Promise<boolean>;

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Decides if we need to refresh the claim value before checking the payload with validate. E.g.: if the information in the payload is expired, or is not sufficient for this validator.

Parameters
Parameter Type
accessTokenPayload any
userContext any
Returns

boolean | Promise<boolean>

validate()
validate(accessTokenPayload, userContext): 
  | ClaimValidationResult
| Promise<ClaimValidationResult>;

Defined in: node_modules/supertokens-website/lib/build/types.d.ts

Decides if the claim is valid based on the accessTokenPayload object (and not checking DB or anything else)

Parameters
Parameter Type
accessTokenPayload any
userContext any
Returns

| ClaimValidationResult | Promise<ClaimValidationResult>

Variables

addAxiosInterceptors()

const addAxiosInterceptors: (axiosInstance, userContext?) => void = RecipeWrapper.addAxiosInterceptors;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters

Parameter Type
axiosInstance any
userContext? any

Returns

void

Deprecated

Deprecated

attemptRefreshingSession()

const attemptRefreshingSession: () => Promise<boolean> = RecipeWrapper.attemptRefreshingSession;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Returns

Promise<boolean>

doesSessionExist()

const doesSessionExist: (input?) => Promise<boolean> = RecipeWrapper.doesSessionExist;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters

Parameter Type
input? { userContext?: any; }
input.userContext? any

Returns

Promise<boolean>

getAccessToken()

const getAccessToken: (input?) => Promise<string> = RecipeWrapper.getAccessToken;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters

Parameter Type
input? { userContext?: any; }
input.userContext? any

Returns

Promise<string>

getAccessTokenPayloadSecurely()

const getAccessTokenPayloadSecurely: (input?) => Promise<any> = RecipeWrapper.getAccessTokenPayloadSecurely;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters

Parameter Type
input? { userContext?: any; }
input.userContext? any

Returns

Promise<any>

getClaimValue()

const getClaimValue: <T>(input) => Promise<T> = RecipeWrapper.getClaimValue;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Type Parameters

Type Parameter
T

Parameters

Parameter Type
input { claim: SessionClaim<T>; userContext?: any; }
input.claim SessionClaim<T>
input.userContext? any

Returns

Promise<T>

getInvalidClaimsFromResponse()

const getInvalidClaimsFromResponse: (input) => Promise<ClaimValidationError[]> = RecipeWrapper.getInvalidClaimsFromResponse;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters

Parameter Type
input { response: | Response | { data: any; }; userContext?: any; }
input.response | Response | { data: any; }
input.userContext? any

Returns

Promise<ClaimValidationError[]>

getUserId()

const getUserId: (input?) => Promise<string> = RecipeWrapper.getUserId;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters

Parameter Type
input? { userContext?: any; }
input.userContext? any

Returns

Promise<string>

init()

const init: (config?) => CreateRecipeFunction<unknown> = RecipeWrapper.init;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters

Parameter Type
config? UserInput

Returns

CreateRecipeFunction<unknown>

signOut()

const signOut: (input?) => Promise<void> = RecipeWrapper.signOut;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters

Parameter Type
input? { userContext?: any; }
input.userContext? any

Returns

Promise<void>

validateClaims()

const validateClaims: (input?) => 
  | ClaimValidationError[]
  | Promise<ClaimValidationError[]> = RecipeWrapper.validateClaims;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/session/index.ts

Parameters

Parameter Type
input? { overrideGlobalClaimValidators?: (globalClaimValidators, userContext) => SessionClaimValidator[]; userContext?: any; }
input.overrideGlobalClaimValidators? (globalClaimValidators, userContext) => SessionClaimValidator[]
input.userContext? any

Returns

| ClaimValidationError[] | Promise<ClaimValidationError[]>

References

UserInput

Re-exports UserInput

API reference

API schema and response details