接口 YmxStorage

数据缓存

interface YmxStorage {
    clearStorage(): Promise<void>;
    getStorage(data: StorageKey): Promise<StorageResult>;
    getStorageInfo(): Promise<StorageInfoResult>;
    removeStorage(data: StorageKey): Promise<void>;
    setStorage(data: StorageData): Promise<void>;
}

层级 (查看层级一览)

YmxStorage
- Ymx

索引

方法

clearStorage getStorage getStorageInfo removeStorage setStorage

方法

clearStorage

clearStorage(): Promise<void>
清理本地数据缓存

返回 Promise<void>
示例
```
ymx.clearStorage().then(() => {
  alert('success');
});
```
- 定义于 core.d.ts:1014

getStorage

getStorage(data: StorageKey): Promise<StorageResult>
从本地缓存中异步获取指定 key 的内容
参数
- data: StorageKey
返回 Promise<StorageResult>
示例
```
ymx.getStorage({
  key: 'key1'
}).then(res => {
  alert(res.data);
});
```
示例
```
ymx.getStorage({
  key: 'key2'
}).then(res => {
  alert(JSON.stringify(res.data));
});
```
- 定义于 core.d.ts:1000

getStorageInfo

getStorageInfo(): Promise<StorageInfoResult>
异步获取当前 storage 的相关信息

返回 Promise<StorageInfoResult>
示例
```
ymx.getStorageInfo().then(res => {
  alert(JSON.stringify(res));
});
```
- 定义于 core.d.ts:1021

removeStorage

removeStorage(data: StorageKey): Promise<void>
从本地缓存中移除指定 key
参数
- data: StorageKey
返回 Promise<void>
示例
```
ymx.removeStorage({
  key: 'key1'
}).then(() => {
  alert('success');
});
```
- 定义于 core.d.ts:1007

setStorage

setStorage(data: StorageData): Promise<void>
将数据存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB。
参数
- data: StorageData
返回 Promise<void>
示例
```
ymx.setStorage({
  key: 'key1',
  data: 'value 1'
}).then(() => {
  alert('success');
});
```
示例
```
ymx.setStorage({
  key: 'key2',
  data: {
    name: '张三',
    age: 26
  }
}).then(() => {
  alert('success');
});
```
- 定义于 core.d.ts:990