---
title: supertokens-node/recipe/usermetadata/types
description: References documentation for the supertokens-node/recipe/usermetadata/types package
sidebar:
  order: 300
---

## Type Aliases

### APIInterface

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

Defined in: [recipe/usermetadata/types.ts:39](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L39)

***

### RecipeInterface

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

Defined in: [recipe/usermetadata/types.ts:41](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L41)

#### Properties

| Property | Type | Description | Defined in |
| ------ | ------ | ------ | ------ |
| <a id="clearusermetadata"></a> `clearUserMetadata` | (`input`) => `Promise`\<\{ `status`: `"OK"`; \}\> | - | [recipe/usermetadata/types.ts:60](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L60) |
| <a id="getusermetadata"></a> `getUserMetadata` | (`input`) => `Promise`\<\{ `metadata`: `any`; `status`: `"OK"`; \}\> | - | [recipe/usermetadata/types.ts:42](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L42) |
| <a id="updateusermetadata"></a> `updateUserMetadata` | (`input`) => `Promise`\<\{ `metadata`: [`JSONObject`](types#jsonobject); `status`: `"OK"`; \}\> | Updates the metadata object of the user by doing a shallow merge of the stored and the update JSONs and removing properties set to null on the root level of the update object. e.g.: - stored: `{ "preferences": { "theme":"dark" }, "notifications": { "email": true }, "todos": ["example"] }` - update: `{ "notifications": { "sms": true }, "todos": null }` - result: `{ "preferences": { "theme":"dark" }, "notifications": { "sms": true } }` | [recipe/usermetadata/types.ts:55](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L55) |

***

### TypeInput

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

Defined in: [recipe/usermetadata/types.ts:19](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L19)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override"></a> `override?` | `object` | [recipe/usermetadata/types.ts:20](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L20) |
| `override.apis?` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/usermetadata/types.ts:25](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L25) |
| `override.functions?` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/usermetadata/types.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L21) |

***

### TypeNormalisedInput

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

Defined in: [recipe/usermetadata/types.ts:29](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L29)

#### Properties

| Property | Type | Defined in |
| ------ | ------ | ------ |
| <a id="override-1"></a> `override` | `object` | [recipe/usermetadata/types.ts:30](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L30) |
| `override.apis` | (`originalImplementation`, `builder`) => [`APIInterface`](#apiinterface) | [recipe/usermetadata/types.ts:35](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L35) |
| `override.functions` | (`originalImplementation`, `builder`) => [`RecipeInterface`](#recipeinterface) | [recipe/usermetadata/types.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/types.ts#L31) |