createTempClear(params: CreateClearParams)

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

Description

Create an offline password clear code

Parameters

ParameterTypeRequiredDescription
YesClear parameters

Return Value

Type: Promise<TempPasswordResult>
Offline clear code creation result

Error Code

Error CodeError Message
1031Password name too long (over 20 characters)
1044unlockBindingId not specified when not clearing all
1038Cloud: duplicate password name (OFFLINE_PWD_NAME_REPEAT)
1067Cloud: offline passwords exhausted for the period (OFFLINE_PWD_EXAUST_IN_PERIOD)
1040Cloud: record not found (RECORD_NOT_EXIST)

Examples

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