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

## Classes

### default

Defined in: [recipe/usermetadata/index.ts:21](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L21)

#### Constructors

##### Constructor

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

###### Returns

[`default`](#default)

#### Properties

| Property | Modifier | Type | Default value | Defined in |
| ------ | ------ | ------ | ------ | ------ |
| <a id="member-default-init"></a> `init` | `static` | (`config?`) => [`RecipeListFunction`](types#recipelistfunction) | `Recipe.init` | [recipe/usermetadata/index.ts:22](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L22) |

#### Methods

##### clearUserMetadata()

```ts check=false reason="Generated API signature"
static clearUserMetadata(userId, userContext?): Promise<{
  status: "OK";
}>;
```

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

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

##### getUserMetadata()

```ts check=false reason="Generated API signature"
static getUserMetadata(userId, userContext?): Promise<{
  metadata: any;
  status: "OK";
}>;
```

Defined in: [recipe/usermetadata/index.ts:24](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L24)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `metadata`: `any`;
  `status`: `"OK"`;
\}\>

##### updateUserMetadata()

```ts check=false reason="Generated API signature"
static updateUserMetadata(
   userId, 
   metadataUpdate, 
   userContext?): Promise<{
  metadata: JSONObject;
  status: "OK";
}>;
```

Defined in: [recipe/usermetadata/index.ts:31](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L31)

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `metadataUpdate` | [`JSONObject`](types#jsonobject) |
| `userContext?` | `Record`\<`string`, `any`\> |

###### Returns

`Promise`\<\{
  `metadata`: [`JSONObject`](types#jsonobject);
  `status`: `"OK"`;
\}\>

## Variables

### clearUserMetadata()

```ts check=false reason="Generated API signature"
const clearUserMetadata: (userId, userContext?) => Promise<{
  status: "OK";
}> = Wrapper.clearUserMetadata;
```

Defined in: [recipe/usermetadata/index.ts:50](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L50)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `status`: `"OK"`;
\}\>

***

### getUserMetadata()

```ts check=false reason="Generated API signature"
const getUserMetadata: (userId, userContext?) => Promise<{
  metadata: any;
  status: "OK";
}> = Wrapper.getUserMetadata;
```

Defined in: [recipe/usermetadata/index.ts:48](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L48)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `metadata`: `any`;
  `status`: `"OK"`;
\}\>

***

### init()

```ts check=false reason="Generated API signature"
const init: (config?) => RecipeListFunction = Wrapper.init;
```

Defined in: [recipe/usermetadata/index.ts:47](https://github.com/supertokens/supertokens-node/blob/8353a9a70d8b17dd9ff6ffe41201fa2ef0e60218/lib/ts/recipe/usermetadata/index.ts#L47)

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `config?` | [`TypeInput`](recipe-usermetadata-types#typeinput) |

#### Returns

[`RecipeListFunction`](types#recipelistfunction)

***

### updateUserMetadata()

```ts check=false reason="Generated API signature"
const updateUserMetadata: (userId, metadataUpdate, userContext?) => Promise<{
  metadata: JSONObject;
  status: "OK";
}> = Wrapper.updateUserMetadata;
```

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

#### Parameters

| Parameter | Type |
| ------ | ------ |
| `userId` | `string` |
| `metadataUpdate` | [`JSONObject`](types#jsonobject) |
| `userContext?` | `Record`\<`string`, `any`\> |

#### Returns

`Promise`\<\{
  `metadata`: [`JSONObject`](types#jsonobject);
  `status`: `"OK"`;
\}\>

## References

### JSONObject

Re-exports [JSONObject](types#jsonobject)

***

### RecipeInterface

Re-exports [RecipeInterface](recipe-usermetadata-types#recipeinterface)