Skip to main content
References

Session

Classes

BooleanClaim

Defined in: claims/booleanClaim.ts:6

Extends

Constructors

Constructor​
new BooleanClaim(config): BooleanClaim;

Defined in: claims/booleanClaim.ts:7

Parameters​
ParameterType
configany
Returns​

BooleanClaim

Overrides​
BooleanClaimWebJS.constructor

default

Defined in: recipe/session/index.ts:34

Constructors

Constructor​
new default(): default;
Returns​

default

Properties

PropertyModifierTypeDefault valueDefined in
ComponentsOverrideProviderstaticanyRecipeComponentsOverrideContextProviderrecipe/session/index.ts:112
SessionAuthstaticanySessionAuthWrapperrecipe/session/index.ts:38
useClaimValuestatic<T>(claim) => | { loading: true; } | { doesSessionExist: boolean; loading: false; value: T; }useClaimValueFuncrecipe/session/index.ts:36
useSessionContextstatic() => SessionContextTypeuseSessionContextFuncrecipe/session/index.ts:35

Methods

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

Defined in: recipe/session/index.ts:75

Parameters​
ParameterType
axiosInstanceany
userContext?UserContext
Returns​

void

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

Defined in: recipe/session/index.ts:62

Returns​

Promise<boolean>

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

Defined in: recipe/session/index.ts:66

Parameters​
ParameterType
input?{ userContext?: UserContext; }
input.userContext?UserContext
Returns​

Promise<boolean>

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

Defined in: recipe/session/index.ts:50

Parameters​
ParameterType
input?{ userContext?: UserContext; }
input.userContext?UserContext
Returns​

Promise<string>

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

Defined in: recipe/session/index.ts:56

Parameters​
ParameterType
input?{ userContext?: UserContext; }
input.userContext?UserContext
Returns​

Promise<any>

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

Defined in: recipe/session/index.ts:105

Type Parameters​
Type Parameter
T
Parameters​
ParameterType
input{ claim: SessionClaim<T>; userContext?: UserContext; }
input.claimSessionClaim<T>
input.userContext?UserContext
Returns​

Promise<T>

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

Defined in: recipe/session/index.ts:98

Parameters​
ParameterType
input{ response: | Response | { data: any; }; userContext: UserContext; }
input.response| Response | { data: any; }
input.userContextUserContext
Returns​

Promise<ClaimValidationError[]>

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

Defined in: recipe/session/index.ts:44

Parameters​
ParameterType
input?{ userContext?: UserContext; }
input.userContext?UserContext
Returns​

Promise<string>

init()​
static init(config?): any;

Defined in: recipe/session/index.ts:40

Parameters​
ParameterType
config?any
Returns​

any

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

Defined in: recipe/session/index.ts:79

Parameters​
ParameterType
input?{ userContext?: UserContext; }
input.userContext?UserContext
Returns​

Promise<void>

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

Defined in: recipe/session/index.ts:85

Parameters​
ParameterType
input?{ overrideGlobalClaimValidators?: (globalClaimValidators, userContext) => SessionClaimValidator[]; userContext?: UserContext; }
input.overrideGlobalClaimValidators?(globalClaimValidators, userContext) => SessionClaimValidator[]
input.userContext?UserContext
Returns​

ClaimValidationError[] | Promise<ClaimValidationError[]>

PrimitiveArrayClaim<T>

Defined in: claims/primitiveArrayClaim.ts:6

Extends

Type Parameters

Type Parameter
T

Constructors

Constructor​
new PrimitiveArrayClaim<T>(config): PrimitiveArrayClaim<T>;

Defined in: claims/primitiveArrayClaim.ts:7

Parameters​
ParameterType
configany
Returns​

PrimitiveArrayClaim<T>

Overrides​
PrimitiveArrayClaimWebJS<T>.constructor

PrimitiveClaim<T>

Defined in: claims/primitiveClaim.ts:6

Extends

Type Parameters

Type Parameter
T

Constructors

Constructor​
new PrimitiveClaim<T>(config): PrimitiveClaim<T>;

Defined in: claims/primitiveClaim.ts:7

Parameters​
ParameterType
configany
Returns​

PrimitiveClaim<T>

Overrides​
PrimitiveClaimWebJS<T>.constructor

Variables

addAxiosInterceptors()

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

Defined in: recipe/session/index.ts:127

Parameters

ParameterType
axiosInstanceany
userContext?UserContext

Returns

void

Deprecated

Deprecated

attemptRefreshingSession()

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

Defined in: recipe/session/index.ts:122

Returns

Promise<boolean>

doesSessionExist()

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

Defined in: recipe/session/index.ts:123

Parameters

ParameterType
input?{ userContext?: UserContext; }
input.userContext?UserContext

Returns

Promise<boolean>

getAccessToken()

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

Defined in: recipe/session/index.ts:120

Parameters

ParameterType
input?{ userContext?: UserContext; }
input.userContext?UserContext

Returns

Promise<string>

getAccessTokenPayloadSecurely()

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

Defined in: recipe/session/index.ts:121

Parameters

ParameterType
input?{ userContext?: UserContext; }
input.userContext?UserContext

Returns

Promise<any>

getClaimValue()

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

Defined in: recipe/session/index.ts:131

Type Parameters

Type Parameter
T

Parameters

ParameterType
input{ claim: SessionClaim<T>; userContext?: UserContext; }
input.claimSessionClaim<T>
input.userContext?UserContext

Returns

Promise<T>

getInvalidClaimsFromResponse()

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

Defined in: recipe/session/index.ts:130

Parameters

ParameterType
input{ response: | Response | { data: any; }; userContext: UserContext; }
input.response| Response | { data: any; }
input.userContextUserContext

Returns

Promise<ClaimValidationError[]>

getUserId()

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

Defined in: recipe/session/index.ts:119

Parameters

ParameterType
input?{ userContext?: UserContext; }
input.userContext?UserContext

Returns

Promise<string>

init()

const init: (config?) => any = SessionAPIWrapper.init;

Defined in: recipe/session/index.ts:118

Parameters

ParameterType
config?any

Returns

any

SessionAuth

const SessionAuth: any = SessionAPIWrapper.SessionAuth;

Defined in: recipe/session/index.ts:117

SessionComponentsOverrideProvider

const SessionComponentsOverrideProvider: any = SessionAPIWrapper.ComponentsOverrideProvider;

Defined in: recipe/session/index.ts:132

SessionContext

const SessionContext: any;

Defined in: recipe/session/sessionContext.ts:5

signOut()

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

Defined in: recipe/session/index.ts:128

Parameters

ParameterType
input?{ userContext?: UserContext; }
input.userContext?UserContext

Returns

Promise<void>

useClaimValue()

const useClaimValue: <T>(claim) => 
  | {
  loading: true;
}
  | {
  doesSessionExist: boolean;
  loading: false;
  value: T;
} = SessionAPIWrapper.useClaimValue;

Defined in: recipe/session/index.ts:116

Type Parameters

Type Parameter
T

Parameters

ParameterType
claimSessionClaim<T>

Returns

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

useSessionContext()

const useSessionContext: () => SessionContextType = SessionAPIWrapper.useSessionContext;

Defined in: recipe/session/index.ts:115

Returns

SessionContextType

validateClaims()

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

Defined in: recipe/session/index.ts:129

Parameters

ParameterType
input?{ overrideGlobalClaimValidators?: (globalClaimValidators, userContext) => SessionClaimValidator[]; userContext?: UserContext; }
input.overrideGlobalClaimValidators?(globalClaimValidators, userContext) => SessionClaimValidator[]
input.userContext?UserContext

Returns

ClaimValidationError[] | Promise<ClaimValidationError[]>

References

ClaimValidationError

Renames and re-exports SuperTokensWrapper

ClaimValidationResult

Renames and re-exports SuperTokensWrapper

InputType

Re-exports InputType

RecipeInterface

Renames and re-exports SuperTokensWrapper

SessionClaim

Renames and re-exports SuperTokensWrapper

SessionClaimValidator

Renames and re-exports SuperTokensWrapper

SessionContextType

Re-exports SessionContextType