store.delete()
删除一个键。调用方必须明确选择无条件删除或按版本删除。
Syntax
const result = await host.store.delete(key, condition);
Parameters
| 参数 | 类型 | 说明 |
|---|---|---|
key |
string |
有界、规范化的应用键 |
condition |
"any" | { version: u64 } |
必填删除前置条件 |
Return value
{ deleted: boolean }。键不存在且 condition 为 "any" 时返回 { deleted: false };键不存在且 condition 为 { version } 时以 conflict 失败。
Examples
const draft = await host.store.get('draft/current');
if (draft) await host.store.delete('draft/current', { version: draft.version });
Errors
特有错误:denied、invalid-key、conflict、limit-exceeded。
Requirements
- 能力:
host:store.delete - 用户激活:不需要
- 信任档位:green