---
name: "createTempClear"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "createTempClear - 生成清除密码。"
summary: "生成清除密码。可支持清除所有或某个限时密码。"
---

## createTempClear

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

### 描述

创建离线密码清空码

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `CreateClearParams` | 是 | 清空参数 |

### 返回值

类型: `Promise<TempPasswordResult>`

离线清空码创建结果

### 错误码

| 错误码 | 错误信息 |
| --- | --- |
| `1031` | 密码名称过长（超过 20 字符） |
| `1044` | 非全部清空时未指定 unlockBindingId |
| `1038` | 云端：密码名称重复（OFFLINE_PWD_NAME_REPEAT） |
| `1067` | 云端：该周期离线密码已耗尽（OFFLINE_PWD_EXAUST_IN_PERIOD） |
| `1040` | 云端：记录不存在（RECORD_NOT_EXIST） |

### 引用对象

##### `interface` CreateClearParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `name` | `string` | 名称 |
| `unlockBindingId` | `string` | 单个密码绑定 id（clearAll 为 false 时必填） |
| `clearAll` | `boolean` | 是否清除全部限时密码 |


### 示例代码

```ts
import { createTempClear } from '@ray-js/lock-sdk';
const result = await createTempClear({ type: 'all' });
```