Skip to content

pixso.clientStorage

pixso.clientStorage API 允许插件将数据存储在用户的本地。与文档数据存储(例如 setPluginData )不同,此数据不会跨用户同步。它类似于 Window.localStorage API,但它是异步的,并允许存储对象、数组、字符串、数字、布尔值、null、undefined 和Uint8Array。如同 Window.localStorage, 清除浏览器缓存等用户操作可能会清除所有存储的数据。

pixso.clientStorage 存储的数据根据插件 Id 进行区分,因此当前插件无法读取其他存储的数据,如果需要跨插件共享数据,可以使用 setSharedPluginData API。

pixso.clientStorage API 的读写删除操作都是异步,有 getAsyncsetAsyncdeleteAsynckeysAsync 四个方法。

getAsync

  • Type: getAsync(key: string): Promise<any | undefined>
  • Tip: 跨线程通信

根据键 keyclientStorage 存储中检索对应的值。如果该键没有存储任何值,则异步返回 undefined

setAsync

  • Type: setAsync(key: string, value: any): Promise<void>
  • Tip: 跨线程通信

clientStorage 给键 key 存储值value,当存储成功,则 Promise 将会 resolve(),否则将会 reject()

deleteAsync

  • Type: deleteAsync(key: string): Promise<void>
  • Tip: 跨线程通信

根据键 key 删除 clientStorage 相应存储的键值对。

keysAsync

  • Type: keysAsync(): Promise<string[]>
  • Tip: 跨线程通信

检索存储到 clientStorage 所有键值对,返回键列表,可以使用它来枚举 clientStorage API 存储的全部内容。