supertokens-auth-react/recipe/session

References documentation for the supertokens-auth-react/recipe/session package

new BooleanClaim(config): BooleanClaim;

Defined in: claims/booleanClaim.ts

Parameters

Parameter	Type
`config`	`any`

Returns

BooleanClaim

Overrides

BooleanClaimWebJS.constructor

default

Defined in: recipe/session/index.ts

Constructors

Constructor

new default(): default;

Returns

default

Properties

Property	Modifier	Type	Default value	Defined in
`ComponentsOverrideProvider`	`static`	`any`	`RecipeComponentsOverrideContextProvider`	recipe/session/index.ts
`SessionAuth`	`static`	`any`	`SessionAuthWrapper`	recipe/session/index.ts
`useClaimValue`	`static`	<`T`>(`claim`) => \| { `loading`: `true`; } \| { `doesSessionExist`: `boolean`; `loading`: `false`; `value`: `T`; }	`useClaimValueFunc`	recipe/session/index.ts
`useSessionContext`	`static`	() => `SessionContextType`	`useSessionContextFunc`	recipe/session/index.ts

Methods

addAxiosInterceptors()

static addAxiosInterceptors(axiosInstance, userContext?): void;

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`axiosInstance`	`any`
`userContext?`	`UserContext`

Returns

void

Deprecated

attemptRefreshingSession()

static attemptRefreshingSession(): Promise<boolean>;

Defined in: recipe/session/index.ts

Returns

Promise<boolean>

doesSessionExist()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`input?`	{ `userContext?`: `UserContext`; }
`input.userContext?`	`UserContext`

Returns

Promise<boolean>

getAccessToken()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`input?`	{ `userContext?`: `UserContext`; }
`input.userContext?`	`UserContext`

Returns

Promise<string>

getAccessTokenPayloadSecurely()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`input?`	{ `userContext?`: `UserContext`; }
`input.userContext?`	`UserContext`

Returns

Promise<any>

getClaimValue()

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

Defined in: recipe/session/index.ts

Type Parameters

Type Parameter
`T`

Parameters

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

Returns

Promise<T>

getInvalidClaimsFromResponse()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`input`	{ `response`: \| `Response` \| { `data`: `any`; }; `userContext`: `UserContext`; }
`input.response`	\| `Response` \| { `data`: `any`; }
`input.userContext`	`UserContext`

Returns

Promise<ClaimValidationError[]>

getUserId()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`input?`	{ `userContext?`: `UserContext`; }
`input.userContext?`	`UserContext`

Returns

Promise<string>

init()

static init(config?): any;

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`config?`	`any`

Returns

any

signOut()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`input?`	{ `userContext?`: `UserContext`; }
`input.userContext?`	`UserContext`

Returns

Promise<void>

validateClaims()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`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

Extends

SuperTokensWrapper<T>

Type Parameters

Type Parameter
`T`

Constructors

Constructor

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

Defined in: claims/primitiveArrayClaim.ts

Parameters

Parameter	Type
`config`	`any`

Returns

PrimitiveArrayClaim<T>

Overrides

PrimitiveArrayClaimWebJS<T>.constructor

PrimitiveClaim<T>

Defined in: claims/primitiveClaim.ts

Extends

SuperTokensWrapper<T>

Type Parameters

Type Parameter
`T`

Constructors

Constructor

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

Defined in: claims/primitiveClaim.ts

Parameters

Parameter	Type
`config`	`any`

Returns

PrimitiveClaim<T>

Overrides

PrimitiveClaimWebJS<T>.constructor

Variables

addAxiosInterceptors()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`axiosInstance`	`any`
`userContext?`	`UserContext`

Returns

void

Deprecated

attemptRefreshingSession()

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

Defined in: recipe/session/index.ts

Returns

Promise<boolean>

doesSessionExist()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`input?`	{ `userContext?`: `UserContext`; }
`input.userContext?`	`UserContext`

Returns

Promise<boolean>

getAccessToken()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`input?`	{ `userContext?`: `UserContext`; }
`input.userContext?`	`UserContext`

Returns

Promise<string>

getAccessTokenPayloadSecurely()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`input?`	{ `userContext?`: `UserContext`; }
`input.userContext?`	`UserContext`

Returns

Promise<any>

getClaimValue()

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

Defined in: recipe/session/index.ts

Type Parameters

Type Parameter
`T`

Parameters

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

Returns

Promise<T>

getInvalidClaimsFromResponse()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`input`	{ `response`: \| `Response` \| { `data`: `any`; }; `userContext`: `UserContext`; }
`input.response`	\| `Response` \| { `data`: `any`; }
`input.userContext`	`UserContext`

Returns

Promise<ClaimValidationError[]>

getUserId()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`input?`	{ `userContext?`: `UserContext`; }
`input.userContext?`	`UserContext`

Returns

Promise<string>

init()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`config?`	`any`

Returns

any

SessionAuth

const SessionAuth: any = SessionAPIWrapper.SessionAuth;

Defined in: recipe/session/index.ts

SessionComponentsOverrideProvider

const SessionComponentsOverrideProvider: any = SessionAPIWrapper.ComponentsOverrideProvider;

Defined in: recipe/session/index.ts

SessionContext

const SessionContext: any;

Defined in: recipe/session/sessionContext.ts

signOut()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`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

Type Parameters

Type Parameter
`T`

Parameters

Parameter	Type
`claim`	`SessionClaim`<`T`>

Returns

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

useSessionContext()

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

Defined in: recipe/session/index.ts

Returns

SessionContextType

validateClaims()

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

Defined in: recipe/session/index.ts

Parameters

Parameter	Type
`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