---
name: "createTempLimit"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "createTempLimit - 创建临时限时密码。"
summary: "创建临时限时密码。"
---

## createTempLimit

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

### 描述

创建临时限时密码

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `CreateLimitParams` | 是 | 参数 |

### 返回值

类型: `Promise<TempPasswordResult>`

限时临时密码创建结果

### 错误码

| 错误码 | 错误信息 |
| --- | --- |
| `1031` | 密码名称过长（超过 20 字符） |
| `1010` | 生效时间大于过期时间 |
| `1038` | 云端：密码名称重复（OFFLINE_PWD_NAME_REPEAT） |
| `1067` | 云端：该周期离线密码已耗尽（OFFLINE_PWD_EXAUST_IN_PERIOD） |

### 引用对象

##### `interface` CreateLimitParams

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `name` | `string` | 密码名称，长度不能超过 20 |
| `effectiveTime` | `number` | 密码生效开始时间，单位为秒 |
| `invalidTime` | `number` | 密码生效结束时间，单位为秒 |


### 示例代码

```ts
import { createTempLimit } from '@ray-js/lock-sdk';
const result = await createTempLimit({ count: 5 });
```