Skip to content

pixso.serverStorage

pixso.serverStorage API 可记录用户在插件上的设置项目。用户只要使用某个账号,在不同文件、不同项目中打开设计文件,使用该插件的时候,该偏好项的取值均为他设置的这个值。

pixso.serverStorage 存储的数据根据插件 Id 进行区分,因此当前插件无法读取其他插件存储的配置数据。

pixso.serverStorage API 的读写删除操作都是异步,有 getAsyncsetAsyncdeleteAsync 三个方法。

getAsync

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

key是可选参数。如果没有传键 key,则从 serverStorage 存储中检索该插件下用户所配置的所有信息(如果该用户没有对该插件做过任何配置,则异步返回{});如果传了键 key,则根据键 key检索对应的配置项内容(如果该键没有存储任何值,则异步返回 undefined)。

setAsync

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

serverStorage 给键 key 存储值value,当存储成功,则异步返回插件的最新配置项,否则将会 reject()

deleteAsync

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

key是可选参数。如果没有传键 key,则删除该插件的所有配置信息;如果传了,键 key根据键 key 删除 serverStorage 相应存储的键值对。