---
title: supertokens-node/types
description: References documentation for the supertokens-node/types package
sidebar:
  order: 20
---

## Interfaces

### HttpRequest

Defined in: [types.ts:197](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L197)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="body"></a> `body?` | `any` | [types.ts:202](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L202) |
| <a id="headers"></a> `headers` | `object` | [types.ts:200](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L200) |
| <a id="method"></a> `method` | [`HTTPMethod`](#httpmethod) | [types.ts:199](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L199) |
| <a id="params"></a> `params?` | `Record`\<`string`, `boolean` \| `number` \| `string` \| `undefined`\> | [types.ts:201](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L201) |
| <a id="url"></a> `url` | `string` | [types.ts:198](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L198) |

***

### JSONObject

Defined in: [types.ts:223](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L223)

#### Indexable

```ts check=false reason="Generated API signature"
[ind: string]: JSONValue
```

## Type Aliases

### AllRecipeConfigs

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

Defined in: [types.ts:90](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L90)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="accountlinking"></a> `accountlinking` | [`TypeInput`](recipe-accountlinking-types#typeinput) & `object` | [types.ts:91](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L91) |
| <a id="dashboard"></a> `dashboard` | [`TypeInput`](recipe-dashboard-types#typeinput) | [types.ts:92](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L92) |
| <a id="emailpassword"></a> `emailpassword` | [`TypeInput`](recipe-emailpassword-types#typeinput) | [types.ts:93](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L93) |
| <a id="emailverification"></a> `emailverification` | [`TypeInput`](recipe-emailverification-types#typeinput) | [types.ts:94](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L94) |
| <a id="jwt"></a> `jwt` | [`TypeInput`](recipe-jwt-types#typeinput) | [types.ts:95](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L95) |
| <a id="multifactorauth"></a> `multifactorauth` | [`TypeInput`](recipe-multifactorauth-types#typeinput) | [types.ts:96](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L96) |
| <a id="multitenancy"></a> `multitenancy` | [`TypeInput`](recipe-multitenancy-types#typeinput) | [types.ts:97](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L97) |
| <a id="oauth2provider"></a> `oauth2provider` | [`TypeInput`](recipe-oauth2provider-types#typeinput) | [types.ts:98](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L98) |
| <a id="openid"></a> `openid` | [`TypeInput`](recipe-openid-types#typeinput) | [types.ts:99](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L99) |
| <a id="passwordless"></a> `passwordless` | [`TypeInput`](recipe-passwordless-types#typeinput) | [types.ts:100](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L100) |
| <a id="session"></a> `session` | `SessionTypeInput` | [types.ts:101](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L101) |
| <a id="thirdparty"></a> `thirdparty` | [`TypeInput`](recipe-thirdparty-types#typeinput) | [types.ts:102](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L102) |
| <a id="totp"></a> `totp` | [`TypeInput`](recipe-totp-types#typeinput) | [types.ts:103](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L103) |
| <a id="usermetadata"></a> `usermetadata` | [`TypeInput`](recipe-usermetadata-types#typeinput) | [types.ts:104](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L104) |
| <a id="userroles"></a> `userroles` | [`TypeInput`](recipe-userroles-types#typeinput) | [types.ts:105](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L105) |
| <a id="webauthn"></a> `webauthn` | [`TypeInput`](recipe-webauthn-types#typeinput) | [types.ts:106](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L106) |

***

### APIHandled

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

Defined in: [types.ts:211](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L211)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="disabled"></a> `disabled` | `boolean` | [types.ts:215](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L215) |
| <a id="id"></a> `id` | `string` | [types.ts:214](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L214) |
| <a id="method-1"></a> `method` | [`HTTPMethod`](#httpmethod) | [types.ts:213](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L213) |
| <a id="pathwithoutapibasepath"></a> `pathWithoutApiBasePath` | `NormalisedURLPath` | [types.ts:212](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L212) |

***

### AppInfo

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

Defined in: [types.ts:62](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L62)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="apibasepath"></a> `apiBasePath?` | `string` | [types.ts:68](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L68) |
| <a id="apidomain"></a> `apiDomain` | `string` | [types.ts:67](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L67) |
| <a id="apigatewaypath"></a> `apiGatewayPath?` | `string` | [types.ts:69](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L69) |
| <a id="appname"></a> `appName` | `string` | [types.ts:63](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L63) |
| <a id="origin"></a> `origin?` | `string` \| (`input`) => `string` | [types.ts:65](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L65) |
| <a id="websitebasepath"></a> `websiteBasePath?` | `string` | [types.ts:66](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L66) |
| <a id="websitedomain"></a> `websiteDomain?` | `string` | [types.ts:64](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L64) |

***

### Entries\<T\>

```ts check=false reason="Generated API signature"
type Entries<T> = { [K in keyof T]-?: [K, T[K]] }[keyof T][];
```

Defined in: [types.ts:53](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L53)

#### Type Parameters

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

***

### GeneralErrorResponse

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

Defined in: [types.ts:226](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L226)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="message"></a> `message` | `string` | [types.ts:228](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L228) |
| <a id="status"></a> `status` | `"GENERAL_ERROR"` | [types.ts:227](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L227) |

***

### HTTPMethod

```ts check=false reason="Generated API signature"
type HTTPMethod = "post" | "get" | "delete" | "put" | "patch" | "options" | "trace";
```

Defined in: [types.ts:218](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L218)

***

### JSONArray

```ts check=false reason="Generated API signature"
type JSONArray = JSONValue[];
```

Defined in: [types.ts:221](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L221)

***

### JSONPrimitive

```ts check=false reason="Generated API signature"
type JSONPrimitive = string | number | boolean | null;
```

Defined in: [types.ts:220](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L220)

***

### JSONValue

```ts check=false reason="Generated API signature"
type JSONValue = 
  | JSONPrimitive
  | JSONObject
  | JSONArray
  | undefined;
```

Defined in: [types.ts:222](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L222)

***

### NetworkInterceptor()

```ts check=false reason="Generated API signature"
type NetworkInterceptor = (request, userContext) => HttpRequest;
```

Defined in: [types.ts:195](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L195)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `request` | [`HttpRequest`](#httprequest) |
| `userContext` | [`UserContext`](#usercontext) |

#### Returns

[`HttpRequest`](#httprequest)

***

### NonNullableProperties\<T\>

```ts check=false reason="Generated API signature"
type NonNullableProperties<T> = { [P in keyof T]: NonNullable<T[P]> };
```

Defined in: [types.ts:49](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L49)

#### Type Parameters

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

***

### NonPublicConfigPropertiesType

```ts check=false reason="Generated API signature"
type NonPublicConfigPropertiesType = typeof nonPublicConfigProperties[number];
```

Defined in: [types.ts:163](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L163)

***

### NormalisedAppinfo

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

Defined in: [types.ts:72](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L72)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="apibasepath-1"></a> `apiBasePath` | `NormalisedURLPath` | [types.ts:78](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L78) |
| <a id="apidomain-1"></a> `apiDomain` | `NormalisedURLDomain` | [types.ts:75](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L75) |
| <a id="apigatewaypath-1"></a> `apiGatewayPath` | `NormalisedURLPath` | [types.ts:79](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L79) |
| <a id="appname-1"></a> `appName` | `string` | [types.ts:73](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L73) |
| <a id="getorigin"></a> `getOrigin` | (`input`) => `NormalisedURLDomain` | [types.ts:74](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L74) |
| <a id="gettoplevelwebsitedomain"></a> `getTopLevelWebsiteDomain` | (`input`) => `string` | [types.ts:77](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L77) |
| <a id="toplevelapidomain"></a> `topLevelAPIDomain` | `string` | [types.ts:76](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L76) |
| <a id="websitebasepath-1"></a> `websiteBasePath` | `NormalisedURLPath` | [types.ts:80](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L80) |

***

### PluginRouteHandler

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

Defined in: [types.ts:115](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L115)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="handler"></a> `handler` | (`req`, `res`, `session`, `userContext`) => `Promise`\< \| \{ `body`: [`JSONObject`](#jsonobject); `status`: `number`; \} \| `null`\> | [types.ts:119](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L119) |
| <a id="method-2"></a> `method` | [`HTTPMethod`](#httpmethod) | [types.ts:116](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L116) |
| <a id="path"></a> `path` | `string` | [types.ts:117](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L117) |
| <a id="verifysessionoptions"></a> `verifySessionOptions?` | `VerifySessionOptions` | [types.ts:118](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L118) |

***

### RecipeListFunction()

```ts check=false reason="Generated API signature"
type RecipeListFunction = (appInfo, isInServerlessEnv, overrideMaps) => RecipeModule;
```

Defined in: [types.ts:205](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L205)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `appInfo` | [`NormalisedAppinfo`](#normalisedappinfo) |
| `isInServerlessEnv` | `boolean` |
| `overrideMaps` | `NonNullable`\<[`SuperTokensPlugin`](#supertokensplugin)\[`"overrideMap"`\]\>[] |

#### Returns

`RecipeModule`

***

### RecipePluginOverride\<T\>

```ts check=false reason="Generated API signature"
type RecipePluginOverride<T> = object;
```

Defined in: [types.ts:109](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L109)

#### Type Parameters

| Type Parameter |
| ------ |
| `T` *extends* keyof [`AllRecipeConfigs`](#allrecipeconfigs) |

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="apis"></a> `apis?` | `NonNullable`\<[`AllRecipeConfigs`](#allrecipeconfigs)\[`T`\]\[`"override"`\]\>\[`"apis"`\] | [types.ts:111](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L111) |
| <a id="config"></a> `config?` | (`config`) => [`AllRecipeConfigs`](#allrecipeconfigs)\[`T`\] | [types.ts:112](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L112) |
| <a id="functions"></a> `functions?` | `NonNullable`\<[`AllRecipeConfigs`](#allrecipeconfigs)\[`T`\]\[`"override"`\]\>\[`"functions"`\] | [types.ts:110](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L110) |

***

### SuperTokensConfigWithNormalisedAppInfo

```ts check=false reason="Generated API signature"
type SuperTokensConfigWithNormalisedAppInfo = Omit<TypeInput, "appInfo"> & object;
```

Defined in: [types.ts:165](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L165)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `appInfo` | [`NormalisedAppinfo`](#normalisedappinfo) | [types.ts:166](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L166) |

***

### SuperTokensInfo

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

Defined in: [types.ts:83](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L83)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="apikey"></a> `apiKey?` | `string` | [types.ts:85](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L85) |
| <a id="connectionuri"></a> `connectionURI` | `string` | [types.ts:84](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L84) |
| <a id="disablecorecallcache"></a> `disableCoreCallCache?` | `boolean` | [types.ts:87](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L87) |
| <a id="networkinterceptor-1"></a> `networkInterceptor?` | [`NetworkInterceptor`](#networkinterceptor) | [types.ts:86](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L86) |

***

### SuperTokensPlugin

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

Defined in: [types.ts:130](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L130)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="compatiblesdkversions"></a> `compatibleSDKVersions?` | `string` \| `string`[] | [types.ts:133](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L133) |
| <a id="config-1"></a> `config?` | (`config`) => \| `Omit`\<[`SuperTokensPublicConfig`](#supertokenspublicconfig), `"appInfo"`\> \| `undefined` | [types.ts:152](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L152) |
| <a id="dependencies"></a> `dependencies?` | (`config`, `pluginsAbove`, `sdkVersion`) => \| \{ `pluginsToAdd?`: [`SuperTokensPlugin`](#supertokensplugin)[]; `status`: `"OK"`; \} \| \{ `message`: `string`; `status`: `"ERROR"`; \} | [types.ts:135](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L135) |
| <a id="exports"></a> `exports?` | `Record`\<`string`, `any`\> | [types.ts:153](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L153) |
| <a id="id-1"></a> `id` | `string` | [types.ts:131](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L131) |
| <a id="init"></a> `init?` | (`config`, `allPlugins`, `sdkVersion`) => `void` | [types.ts:134](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L134) |
| <a id="overridemap"></a> `overrideMap?` | \{ \[recipeId in keyof AllRecipeConfigs\]?: RecipePluginOverride\<recipeId\> & \{ recipeInitRequired?: boolean \| ((sdkVersion: string) =\> boolean) \} \} | [types.ts:140](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L140) |
| <a id="routehandlers"></a> `routeHandlers?` | \| (`config`, `allPlugins`, `sdkVersion`) => \| \{ `routeHandlers`: [`PluginRouteHandler`](#pluginroutehandler)[]; `status`: `"OK"`; \} \| \{ `message`: `string`; `status`: `"ERROR"`; \} \| [`PluginRouteHandler`](#pluginroutehandler)[] | [types.ts:145](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L145) |
| <a id="version"></a> `version?` | `string` | [types.ts:132](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L132) |

***

### SuperTokensPublicConfig

```ts check=false reason="Generated API signature"
type SuperTokensPublicConfig = Omit<Omit<TypeInput, NonPublicConfigPropertiesType>, "appInfo"> & object;
```

Defined in: [types.ts:169](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L169)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `appInfo` | [`NormalisedAppinfo`](#normalisedappinfo) | [types.ts:170](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L170) |

***

### SuperTokensPublicPlugin

```ts check=false reason="Generated API signature"
type SuperTokensPublicPlugin = Pick<SuperTokensPlugin, "id" | "version" | "compatibleSDKVersions" | "exports"> & object;
```

Defined in: [types.ts:156](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L156)

#### Type Declaration

| Name | Type | Defined in |
| ------ | ------ | ------ |
| `initialized` | `boolean` | [types.ts:159](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L159) |

***

### TypeInput

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

Defined in: [types.ts:173](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L173)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="appinfo-1"></a> `appInfo` | [`AppInfo`](#appinfo) | - | [types.ts:176](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L176) |
| <a id="debug"></a> `debug?` | `boolean` | - | [types.ts:180](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L180) |
| <a id="experimental"></a> `experimental?` | `object` | Our experimental features are not yet stable and are subject to change. In practical terms, this means that their interface is subject to change without a major version update. They are also not tested as much as our "normal" features. If you want to use these features, or if you have any feedback please let us know at: https://supertokens.com/discord | [types.ts:190](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L190) |
| `experimental.plugins?` | [`SuperTokensPlugin`](#supertokensplugin)[] | - | [types.ts:191](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L191) |
| <a id="framework"></a> `framework?` | `TypeFramework` | - | [types.ts:175](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L175) |
| <a id="isinserverlessenv"></a> `isInServerlessEnv?` | `boolean` | - | [types.ts:179](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L179) |
| <a id="recipelist"></a> `recipeList` | [`RecipeListFunction`](#recipelistfunction)[] | - | [types.ts:177](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L177) |
| <a id="supertokens"></a> `supertokens?` | [`SuperTokensInfo`](#supertokensinfo) | - | [types.ts:174](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L174) |
| <a id="telemetry"></a> `telemetry?` | `boolean` | - | [types.ts:178](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L178) |

***

### User

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

Defined in: [types.ts:231](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L231)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="emails"></a> `emails` | `string`[] | [types.ts:236](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L236) |
| <a id="id-2"></a> `id` | `string` | [types.ts:232](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L232) |
| <a id="isprimaryuser"></a> `isPrimaryUser` | `boolean` | [types.ts:234](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L234) |
| <a id="loginmethods"></a> `loginMethods` | [`RecipeLevelUser`](recipe-accountlinking-types#recipeleveluser) & `object`[] | [types.ts:245](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L245) |
| <a id="phonenumbers"></a> `phoneNumbers` | `string`[] | [types.ts:237](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L237) |
| <a id="tenantids"></a> `tenantIds` | `string`[] | [types.ts:235](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L235) |
| <a id="thirdparty-1"></a> `thirdParty` | `object`[] | [types.ts:238](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L238) |
| <a id="timejoined"></a> `timeJoined` | `number` | [types.ts:233](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L233) |
| <a id="tojson"></a> `toJson` | () => `any` | [types.ts:257](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L257) |
| <a id="webauthn-1"></a> `webauthn` | `object` | [types.ts:242](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L242) |
| `webauthn.credentialIds` | `string`[] | [types.ts:243](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L243) |

***

### UserContext

```ts check=false reason="Generated API signature"
type UserContext = Branded<Record<string, any>, "UserContext">;
```

Defined in: [types.ts:60](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L60)

## Variables

### nonPublicConfigProperties

```ts check=false reason="Generated API signature"
const nonPublicConfigProperties: readonly ["recipeList", "experimental"];
```

Defined in: [types.ts:161](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/types.ts#L161)