createTempLimit(params: CreateLimitParams)

Requires:
@ray-js/lock-sdk≥1.0.0

Description

Create a time-limited temporary password

Parameters

ParameterTypeRequiredDescription
YesParameters

Return Value

Type: Promise<TempPasswordResult>
Time-limited temporary password creation result

Error Code

Error CodeError Message
1031Password name too long (exceeds 20 characters)
1010Start time is later than expiry time
1038Cloud: Duplicate password name (OFFLINE_PWD_NAME_REPEAT)
1067Cloud: Offline passwords for the period exhausted (OFFLINE_PWD_EXAUST_IN_PERIOD)

Examples

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