---
title: supertokens-web-js/recipe/session
description: References documentation for the supertokens-web-js/recipe/session package
sidebar:
  order: 150
---

## Classes

### BooleanClaim

Defined in: node\_modules/supertokens-website/lib/build/claims/booleanClaim.d.ts:7

#### Extends

- [`PrimitiveClaim`](#primitiveclaim)\<`boolean`\>

#### Extended by

- [`EmailVerificationClaimClass`](recipe-emailverification#emailverificationclaimclass)

#### Constructors

##### Constructor

```ts check=false reason="Generated API signature"
new BooleanClaim(config): BooleanClaim;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/booleanClaim.d.ts:8

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`PrimitiveClaimConfig`](#primitiveclaimconfig) |

###### Returns

[`BooleanClaim`](#booleanclaim)

###### Overrides

[`PrimitiveClaim`](#primitiveclaim).[`constructor`](#constructor-3)

#### Properties

| Property | Modifier | Type | Overrides | Inherited from | Defined in |
| ------ | ------ | ------ | ------ | ------ | ------ |
| <a id="defaultmaxageinseconds"></a> `defaultMaxAgeInSeconds` | `readonly` | `number` | - | [`PrimitiveClaim`](#primitiveclaim).[`defaultMaxAgeInSeconds`](#defaultmaxageinseconds-2) | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:10 |
| <a id="id"></a> `id` | `readonly` | `string` | - | [`PrimitiveClaim`](#primitiveclaim).[`id`](#id-2) | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:8 |
| <a id="member-booleanclaim-refresh"></a> `refresh` | `readonly` | (`userContext`) => `Promise`\<`void`\> | - | [`PrimitiveClaim`](#primitiveclaim).[`refresh`](#refresh-2) | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:9 |
| <a id="validators"></a> `validators` | `public` | `object` & `BooleanValidators` | [`PrimitiveClaim`](#primitiveclaim).[`validators`](#validators-2) | - | node\_modules/supertokens-website/lib/build/claims/booleanClaim.d.ts:9 |

#### Methods

##### getLastFetchedTime()

```ts check=false reason="Generated API signature"
getLastFetchedTime(payload, _userContext?): number;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:13

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`number`

###### Inherited from

[`PrimitiveClaim`](#primitiveclaim).[`getLastFetchedTime`](#getlastfetchedtime)

##### getValueFromPayload()

```ts check=false reason="Generated API signature"
getValueFromPayload(payload, _userContext?): boolean;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:12

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`boolean`

###### Inherited from

[`PrimitiveClaim`](#primitiveclaim).[`getValueFromPayload`](#getvaluefrompayload)

***

### default

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:22](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L22)

#### Constructors

##### Constructor

```ts check=false reason="Generated API signature"
new default(): default;
```

###### Returns

[`default`](#default)

#### Methods

##### ~~addAxiosInterceptors()~~

```ts check=false reason="Generated API signature"
static addAxiosInterceptors(axiosInstance, userContext?): void;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:59](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L59)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `axiosInstance` | `any` |
| `userContext?` | `any` |

###### Returns

`void`

###### Deprecated

##### attemptRefreshingSession()

```ts check=false reason="Generated API signature"
static attemptRefreshingSession(): Promise<boolean>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:45](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L45)

###### Returns

`Promise`\<`boolean`\>

##### doesSessionExist()

```ts check=false reason="Generated API signature"
static doesSessionExist(input?): Promise<boolean>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:49](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L49)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`boolean`\>

##### getAccessToken()

```ts check=false reason="Generated API signature"
static getAccessToken(input?): Promise<string>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:33](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L33)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`string`\>

##### getAccessTokenPayloadSecurely()

```ts check=false reason="Generated API signature"
static getAccessTokenPayloadSecurely(input?): Promise<any>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:39](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L39)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`any`\>

##### getClaimValue()

```ts check=false reason="Generated API signature"
static getClaimValue<T>(input): Promise<T>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:69](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L69)

###### Type Parameters

| Type Parameter |
| ------ |
| `T` |

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `claim`: [`SessionClaim`](#sessionclaim)\<`T`\>; `userContext?`: `any`; \} |
| `input.claim` | [`SessionClaim`](#sessionclaim)\<`T`\> |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`T`\>

##### getInvalidClaimsFromResponse()

```ts check=false reason="Generated API signature"
static getInvalidClaimsFromResponse(input): Promise<ClaimValidationError[]>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:90](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L90)

###### Parameters

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

###### Returns

`Promise`\<[`ClaimValidationError`](#claimvalidationerror)[]\>

##### getUserId()

```ts check=false reason="Generated API signature"
static getUserId(input?): Promise<string>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:27](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L27)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`string`\>

##### init()

```ts check=false reason="Generated API signature"
static init(config?): CreateRecipeFunction<unknown>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:23](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L23)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-session-types#userinput) |

###### Returns

[`CreateRecipeFunction`](types#createrecipefunction)\<`unknown`\>

##### signOut()

```ts check=false reason="Generated API signature"
static signOut(input?): Promise<void>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:63](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L63)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

###### Returns

`Promise`\<`void`\>

##### validateClaims()

```ts check=false reason="Generated API signature"
static validateClaims(input?): 
  | ClaimValidationError[]
| Promise<ClaimValidationError[]>;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:76](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L76)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `overrideGlobalClaimValidators?`: (`globalClaimValidators`, `userContext`) => [`SessionClaimValidator`](#sessionclaimvalidator)[]; `userContext?`: `any`; \} |
| `input.overrideGlobalClaimValidators?` | (`globalClaimValidators`, `userContext`) => [`SessionClaimValidator`](#sessionclaimvalidator)[] |
| `input.userContext?` | `any` |

###### Returns

  \| [`ClaimValidationError`](#claimvalidationerror)[]
  \| `Promise`\<[`ClaimValidationError`](#claimvalidationerror)[]\>

***

### PrimitiveArrayClaim\<ValueType\>

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:7

#### Type Parameters

| Type Parameter |
| ------ |
| `ValueType` |

#### Constructors

##### Constructor

```ts check=false reason="Generated API signature"
new PrimitiveArrayClaim<ValueType>(config): PrimitiveArrayClaim<ValueType>;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:11

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`PrimitiveArrayClaimConfig`](#primitivearrayclaimconfig) |

###### Returns

[`PrimitiveArrayClaim`](#primitivearrayclaim)\<`ValueType`\>

#### Properties

| Property | Modifier | Type | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="defaultmaxageinseconds-1"></a> `defaultMaxAgeInSeconds` | `readonly` | `number` | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:10 |
| <a id="id-1"></a> `id` | `readonly` | `string` | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:8 |
| <a id="member-primitivearrayclaim-refresh"></a> `refresh` | `readonly` | (`userContext`) => `Promise`\<`void`\> | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:9 |
| <a id="validators-1"></a> `validators` | `public` | `object` | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:14 |
| `validators.excludes` | `public` | (`val`, `maxAgeInSeconds?`, `id?`) => [`SessionClaimValidator`](#sessionclaimvalidator) | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:16 |
| `validators.excludesAll` | `public` | (`val`, `maxAgeInSeconds?`, `id?`) => [`SessionClaimValidator`](#sessionclaimvalidator) | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:19 |
| `validators.includes` | `public` | (`val`, `maxAgeInSeconds?`, `id?`) => [`SessionClaimValidator`](#sessionclaimvalidator) | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:15 |
| `validators.includesAll` | `public` | (`val`, `maxAgeInSeconds?`, `id?`) => [`SessionClaimValidator`](#sessionclaimvalidator) | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:17 |
| `validators.includesAny` | `public` | (`val`, `maxAgeInSeconds?`, `id?`) => [`SessionClaimValidator`](#sessionclaimvalidator) | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:18 |

#### Methods

##### getLastFetchedTime()

```ts check=false reason="Generated API signature"
getLastFetchedTime(payload, _userContext?): number;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:13

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`number`

##### getValueFromPayload()

```ts check=false reason="Generated API signature"
getValueFromPayload(payload, _userContext?): ValueType[];
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:12

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`ValueType`[]

***

### PrimitiveClaim\<ValueType\>

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:7

#### Extended by

- [`BooleanClaim`](#booleanclaim)

#### Type Parameters

| Type Parameter |
| ------ |
| `ValueType` |

#### Constructors

##### Constructor

```ts check=false reason="Generated API signature"
new PrimitiveClaim<ValueType>(config): PrimitiveClaim<ValueType>;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:11

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `config` | [`PrimitiveClaimConfig`](#primitiveclaimconfig) |

###### Returns

[`PrimitiveClaim`](#primitiveclaim)\<`ValueType`\>

#### Properties

| Property | Modifier | Type | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="defaultmaxageinseconds-2"></a> `defaultMaxAgeInSeconds` | `readonly` | `number` | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:10 |
| <a id="id-2"></a> `id` | `readonly` | `string` | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:8 |
| <a id="refresh-2"></a> `refresh` | `readonly` | (`userContext`) => `Promise`\<`void`\> | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:9 |
| <a id="validators-2"></a> `validators` | `public` | `object` | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:14 |
| `validators.hasValue` | `public` | (`val`, `maxAgeInSeconds?`, `id?`) => [`SessionClaimValidator`](#sessionclaimvalidator) | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:15 |

#### Methods

##### getLastFetchedTime()

```ts check=false reason="Generated API signature"
getLastFetchedTime(payload, _userContext?): number;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:13

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`number`

##### getValueFromPayload()

```ts check=false reason="Generated API signature"
getValueFromPayload(payload, _userContext?): ValueType;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:12

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`ValueType`

## Type Aliases

### ClaimValidationError

```ts check=false reason="Generated API signature"
type ClaimValidationError = object;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:147

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="id-3"></a> `id` | `string` | node\_modules/supertokens-website/lib/build/types.d.ts:148 |
| <a id="reason"></a> `reason?` | `any` | node\_modules/supertokens-website/lib/build/types.d.ts:149 |

***

### ClaimValidationResult

```ts check=false reason="Generated API signature"
type ClaimValidationResult = 
  | {
  isValid: true;
}
  | {
  isValid: false;
  reason?: any;
};
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:141

***

### PrimitiveArrayClaimConfig

```ts check=false reason="Generated API signature"
type PrimitiveArrayClaimConfig = object;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:2

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="defaultmaxageinseconds-3"></a> `defaultMaxAgeInSeconds?` | `number` | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:5 |
| <a id="id-4"></a> `id` | `string` | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:3 |
| <a id="refresh-3"></a> `refresh` | (`userContext?`) => `Promise`\<`void`\> | node\_modules/supertokens-website/lib/build/claims/primitiveArrayClaim.d.ts:4 |

***

### PrimitiveClaimConfig

```ts check=false reason="Generated API signature"
type PrimitiveClaimConfig = object;
```

Defined in: node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:2

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="defaultmaxageinseconds-4"></a> `defaultMaxAgeInSeconds?` | `number` | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:5 |
| <a id="id-5"></a> `id` | `string` | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:3 |
| <a id="refresh-4"></a> `refresh` | (`userContext?`) => `Promise`\<`void`\> | node\_modules/supertokens-website/lib/build/claims/primitiveClaim.d.ts:4 |

***

### RecipeInterface

```ts check=false reason="Generated API signature"
type RecipeInterface = object;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:97

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="addaxiosinterceptors-2"></a> `addAxiosInterceptors` | (`input`) => `void` | node\_modules/supertokens-website/lib/build/types.d.ts:105 |
| <a id="addfetchinterceptorsandreturnmodifiedfetch"></a> `addFetchInterceptorsAndReturnModifiedFetch` | (`input`) => *typeof* `fetch` | node\_modules/supertokens-website/lib/build/types.d.ts:98 |
| <a id="addxmlhttprequestinterceptor"></a> `addXMLHttpRequestInterceptor` | (`input`) => `void` | node\_modules/supertokens-website/lib/build/types.d.ts:102 |
| <a id="doessessionexist-2"></a> `doesSessionExist` | (`input`) => `Promise`\<`boolean`\> | node\_modules/supertokens-website/lib/build/types.d.ts:115 |
| <a id="getaccesstokenpayloadsecurely-2"></a> `getAccessTokenPayloadSecurely` | (`input`) => `Promise`\<`any`\> | node\_modules/supertokens-website/lib/build/types.d.ts:112 |
| <a id="getuserid-2"></a> `getUserId` | (`input`) => `Promise`\<`string`\> | node\_modules/supertokens-website/lib/build/types.d.ts:109 |
| <a id="signout-2"></a> `signOut` | (`input`) => `Promise`\<`void`\> | node\_modules/supertokens-website/lib/build/types.d.ts:118 |
| <a id="validateclaims-2"></a> `validateClaims` | (`input`) => `Promise`\<[`ClaimValidationError`](#claimvalidationerror)[]\> | node\_modules/supertokens-website/lib/build/types.d.ts:127 |

#### Methods

##### calculateClockSkewInMillis()

```ts check=false reason="Generated API signature"
calculateClockSkewInMillis(params): number;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:136

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `params` | \{ `accessTokenPayload`: `any`; `responseHeaders`: `Headers`; \} |
| `params.accessTokenPayload` | `any` |
| `params.responseHeaders` | `Headers` |

###### Returns

`number`

##### getGlobalClaimValidators()

```ts check=false reason="Generated API signature"
getGlobalClaimValidators(input): SessionClaimValidator[];
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:131

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `claimValidatorsAddedByOtherRecipes`: [`SessionClaimValidator`](#sessionclaimvalidator)[]; `userContext`: `any`; \} |
| `input.claimValidatorsAddedByOtherRecipes` | [`SessionClaimValidator`](#sessionclaimvalidator)[] |
| `input.userContext` | `any` |

###### Returns

[`SessionClaimValidator`](#sessionclaimvalidator)[]

##### getInvalidClaimsFromResponse()

```ts check=false reason="Generated API signature"
getInvalidClaimsFromResponse(input): Promise<ClaimValidationError[]>;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:121

###### Parameters

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

###### Returns

`Promise`\<[`ClaimValidationError`](#claimvalidationerror)[]\>

##### shouldDoInterceptionBasedOnUrl()

```ts check=false reason="Generated API signature"
shouldDoInterceptionBasedOnUrl(
   toCheckUrl, 
   apiDomain, 
   sessionTokenBackendDomain): boolean;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:135

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `toCheckUrl` | `string` |
| `apiDomain` | `string` |
| `sessionTokenBackendDomain` | `string` |

###### Returns

`boolean`

***

### SessionClaim\<ValueType\>

```ts check=false reason="Generated API signature"
type SessionClaim<ValueType> = object;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:167

#### Type Parameters

| Type Parameter |
| ------ |
| `ValueType` |

#### Methods

##### getLastFetchedTime()

```ts check=false reason="Generated API signature"
getLastFetchedTime(payload, _userContext?): number;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:170

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`number`

##### getValueFromPayload()

```ts check=false reason="Generated API signature"
getValueFromPayload(payload, _userContext?): ValueType;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:169

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `payload` | `any` |
| `_userContext?` | `any` |

###### Returns

`ValueType`

##### refresh()

```ts check=false reason="Generated API signature"
refresh(userContext): Promise<void>;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:168

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext` | `any` |

###### Returns

`Promise`\<`void`\>

***

### SessionClaimValidator

```ts check=false reason="Generated API signature"
type SessionClaimValidator = object;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:151

#### Properties

| Property | Modifier | Type | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="id-6"></a> `id` | `readonly` | `string` | node\_modules/supertokens-website/lib/build/types.d.ts:152 |

#### Methods

##### refresh()

```ts check=false reason="Generated API signature"
refresh(userContext): Promise<void>;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:156

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userContext` | `any` |

###### Returns

`Promise`\<`void`\>

##### shouldRefresh()

```ts check=false reason="Generated API signature"
shouldRefresh(accessTokenPayload, userContext): boolean | Promise<boolean>;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:161

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()

```ts check=false reason="Generated API signature"
validate(accessTokenPayload, userContext): 
  | ClaimValidationResult
| Promise<ClaimValidationResult>;
```

Defined in: node\_modules/supertokens-website/lib/build/types.d.ts:165

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`](#claimvalidationresult)
  \| `Promise`\<[`ClaimValidationResult`](#claimvalidationresult)\>

## Variables

### ~~addAxiosInterceptors()~~

```ts check=false reason="Generated API signature"
const addAxiosInterceptors: (axiosInstance, userContext?) => void = RecipeWrapper.addAxiosInterceptors;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:110](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L110)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `axiosInstance` | `any` |
| `userContext?` | `any` |

#### Returns

`void`

#### Deprecated

#### Deprecated

***

### attemptRefreshingSession()

```ts check=false reason="Generated API signature"
const attemptRefreshingSession: () => Promise<boolean> = RecipeWrapper.attemptRefreshingSession;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:105](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L105)

#### Returns

`Promise`\<`boolean`\>

***

### doesSessionExist()

```ts check=false reason="Generated API signature"
const doesSessionExist: (input?) => Promise<boolean> = RecipeWrapper.doesSessionExist;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:106](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L106)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`boolean`\>

***

### getAccessToken()

```ts check=false reason="Generated API signature"
const getAccessToken: (input?) => Promise<string> = RecipeWrapper.getAccessToken;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:104](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L104)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`string`\>

***

### getAccessTokenPayloadSecurely()

```ts check=false reason="Generated API signature"
const getAccessTokenPayloadSecurely: (input?) => Promise<any> = RecipeWrapper.getAccessTokenPayloadSecurely;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:103](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L103)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`any`\>

***

### getClaimValue()

```ts check=false reason="Generated API signature"
const getClaimValue: <T>(input) => Promise<T> = RecipeWrapper.getClaimValue;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:113](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L113)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input` | \{ `claim`: [`SessionClaim`](#sessionclaim)\<`T`\>; `userContext?`: `any`; \} |
| `input.claim` | [`SessionClaim`](#sessionclaim)\<`T`\> |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`T`\>

***

### getInvalidClaimsFromResponse()

```ts check=false reason="Generated API signature"
const getInvalidClaimsFromResponse: (input) => Promise<ClaimValidationError[]> = RecipeWrapper.getInvalidClaimsFromResponse;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:114](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L114)

#### Parameters

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

#### Returns

`Promise`\<[`ClaimValidationError`](#claimvalidationerror)[]\>

***

### getUserId()

```ts check=false reason="Generated API signature"
const getUserId: (input?) => Promise<string> = RecipeWrapper.getUserId;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:102](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L102)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`string`\>

***

### init()

```ts check=false reason="Generated API signature"
const init: (config?) => CreateRecipeFunction<unknown> = RecipeWrapper.init;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:101](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L101)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`UserInput`](recipe-session-types#userinput) |

#### Returns

[`CreateRecipeFunction`](types#createrecipefunction)\<`unknown`\>

***

### signOut()

```ts check=false reason="Generated API signature"
const signOut: (input?) => Promise<void> = RecipeWrapper.signOut;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:111](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L111)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `userContext?`: `any`; \} |
| `input.userContext?` | `any` |

#### Returns

`Promise`\<`void`\>

***

### validateClaims()

```ts check=false reason="Generated API signature"
const validateClaims: (input?) => 
  | ClaimValidationError[]
  | Promise<ClaimValidationError[]> = RecipeWrapper.validateClaims;
```

Defined in: [tmp/supertokens-web-js/lib/ts/recipe/session/index.ts:112](https://github.com/supertokens/supertokens-web-js/blob/be2e0fd7dcade8352cdc9639abe968e5cda5b1cd/lib/ts/recipe/session/index.ts#L112)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `input?` | \{ `overrideGlobalClaimValidators?`: (`globalClaimValidators`, `userContext`) => [`SessionClaimValidator`](#sessionclaimvalidator)[]; `userContext?`: `any`; \} |
| `input.overrideGlobalClaimValidators?` | (`globalClaimValidators`, `userContext`) => [`SessionClaimValidator`](#sessionclaimvalidator)[] |
| `input.userContext?` | `any` |

#### Returns

  \| [`ClaimValidationError`](#claimvalidationerror)[]
  \| `Promise`\<[`ClaimValidationError`](#claimvalidationerror)[]\>

## References

### UserInput

Re-exports [UserInput](recipe-session-types#userinput)