---
name: "addUser"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "addUser - 添加一个普通成员。"
summary: "添加一个普通成员。注意，如果锁使用了小容量的方案，则不建议使用此 API。"
---

## addUser

> [VERSION] @ray-js/lock-sdk >= 1.0.0

> 💡 如果锁使用了小容量的方案，则不能使用此 API，否则会抛出错误

### 描述

添加一个普通用户

### 参数

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `name` | `string` | 是 | 用户名称 |

### 返回值

类型: `Promise<void>`

无

### 错误码

| 错误码 | 错误信息 |
| --- | --- |
| `1060` | 不支持添加普通成员 |
| `1009` | 缺少必填属性 name |
| `1068` | 已存在同名成员 |

### 示例代码

#### 示例

```ts
import { addUser } from '@ray-js/lock-sdk';
await addUser({ name: '张三' });
```