ZEPETO.Multiplay.DataStorage
类型 | 说明 |
|---|---|
表示数据存储相关请求失败原因的错误代码。 | |
表示数据存储的抽象,提供存储、获取和删除数据的方法。该接口定义了针对单条和多条数据操作的异步方法。 |
DataStorageError
enum
表示数据存储相关请求失败原因的错误代码。
名称 | 值 | 说明 |
|---|---|---|
Unknown | -1 | 错误:未知错误。 |
NetworkError | 0 | 错误:与网络问题相关的错误,包括连接中断或连接不稳定。 |
KeyConstraintViolated | 103 | 错误:键错误。 |
ValueConstraintViolated | 104 | 错误:值错误。 |
DataStorage
interface
表示数据存储的抽象,提供存储、获取和删除数据的方法。 该接口定义了针对单条和多条数据操作的异步方法。
方法
set
set(key: string, value: T) → Promise<boolean>
使用指定的键存储值。会抛出 DataStorageError。
参数 | 类型 | 说明 |
|---|---|---|
key | string | 用于存储的键。 |
value | T | 要存储的数据。 |
返回值: Promise<boolean> — 处理完成时兑现的 Promise,表示成功(true)或失败(false)。
get
get(key: string) → Promise<T>
根据键获取值。会抛出 DataStorageError。
参数 | 类型 | 说明 |
|---|---|---|
key | string | 要查找的键。 |
返回值: Promise<T> — 处理完成时兑现的 Promise,携带 T 类型的值。
remove
remove(key: string) → Promise<boolean>
删除指定键对应的值。会抛出 DataStorageError。
参数 | 类型 | 说明 |
|---|---|---|
key | string | 要查找的键。 |
返回值: Promise<boolean> — 处理完成时兑现的 Promise,表示成功(true)或失败(false)。
mget
mget(keys: string[]) → Promise<{ [key: string]: T }>
根据多个键获取值。会抛出 DataStorageError。
参数 | 类型 | 说明 |
|---|---|---|
keys | string[] | 要查找的键数组。 |
返回值: Promise<{ [key: string]: T }> — 处理完成时兑现的 Promise,携带键值对象。
mset
mset(keyValueSet: { key: string; value: T }[]) → Promise<boolean>
使用指定的多个键存储值。会抛出 DataStorageError。
参数 | 类型 | 说明 |
|---|---|---|
keyValueSet | { key: string; value: T }[] | 要存储的键值对象数组。 |
返回值: Promise<boolean> — 处理完成时兑现的 Promise,表示成功(true)或失败(false)。