数据缓存

has.setStorageSync

has.setStorageSync(string key, string | object | number | boolean | null | array data)

setStorage的同步接口，将数据存储在本地缓存中指定的key中。将覆盖原来该key中的内容。

数据一直可用，直到用户主动删除。

单个key允许存储的最大数据长度为1MB，所有数据存储上限为10MB。

起始版本： 1.0.0

参数：

错误码信息：

示例：

has.setStorageSync('key', 'value');

has.setStorage

has.setStorage(Object object)

setStorageSync的异步接口，将数据存储在本地缓存中指定的key中。将覆盖原来该key中的内容。

数据一直可用，直到用户主动删除。

单个key允许存储的最大数据长度为1MB，所有数据存储上限为10MB。

起始版本： 1.0.0

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

has.setStorage({
  key: 'key',
  data: 'test',
  success: (res) => {
    console.info('setStorage success');
  },
  fail: (err) => {
    console.error('setStorage fail', err);
  },
  complete: (res) => {
    console.info('setStorage complete', res);
  }
});

has.removeStorageSync

has.removeStorageSync(string key)

删除指定key的缓存。

起始版本： 1.0.0

参数：

错误码信息：

示例：

has.removeStorageSync('key');

has.removeStorage

has.removeStorage(Object object)

removeStorageSync的异步接口，删除指定key的缓存。

起始版本： 1.0.0

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

has.removeStorage({
  key: 'key',
  success: () => {
    console.info('removeStorage success');
  },
  fail: (err) => {
    console.error('removeStorage fail', err);
  },
  complete: (res) => {
    console.info('removeStorage complete', res);
  }
});

has.getStorageSync

has.getStorageSync(string key): Object

获取指定key的缓存。

起始版本： 1.0.0

参数：

返回值：

错误码信息：

示例：

has.getStorageSync('key');

has.getStorage

has.getStorage(Object object)

getStorageSync的异步版本，获取指定key的缓存。

起始版本： 1.0.0

参数：

参数为Object对象，包括以下字段。

success返回值：

错误码信息：

示例：

has.getStorage({
  key: 'key',
  success: (res) => {
    console.info('getStorage success:', res);
  },
  fail: (err) => {
    console.error('getStorage fail:', err);
  },
  complete: (res) => {
    console.info('getStorage complete:', res);
  }
});

has.getStorageInfoSync

has.getStorageInfoSync(): Object

获取缓存的信息。

起始版本： 1.0.0

返回值：

返回Object对象，包括以下字段。

错误码信息：

示例：

const storageInfo = has.getStorageInfoSync();
console.info(storageInfo.keys);
console.info(storageInfo.currentSize);
console.info(storageInfo.limitSize);

has.getStorageInfo

has.getStorageInfo(Object object)

getStorageInfoSync的异步版本，获取缓存的信息。

起始版本： 1.0.0

参数：

参数为Object对象，包括以下字段。

success返回值：

错误码信息：

示例：

has.getStorageInfo({
  success: (res) => {
    console.info('getStorageInfo success:', res);
  },
  fail: (err) => {
    console.error('getStorageInfo fail:', err);
  },
  complete: (res) => {
    console.info('getStorageInfo complete:', res);
  }
});

has.clearStorageSync

has.clearStorageSync()

清空本地缓存。

起始版本： 1.0.0

错误码信息：

示例：

has.clearStorageSync();

has.clearStorage

has.clearStorage(Object object)

clearStorageSync的异步版本，清空本地缓存。

起始版本： 1.0.0

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

has.clearStorage({
  success: () => {
    console.info('clearStorage success!');
  },
  fail: (err) => {
    console.error('clearStorage fail:', err);
  },
  complete: (res) => {
    console.info('clearStorage complete:', res);
  }
});

has.batchSetStorageSync

has.batchSetStorageSync(Array<KVPair> kvList): void

将数据批量存储在本地缓存中指定的key中。

会覆盖掉原来该key对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。

单个key允许存储的最大数据长度为1MB，所有数据存储上限为10MB。

起始版本： 1.0.12

参数：

KVPair接口字段：

错误码信息：

示例：

try {
  const kvList = [{ key: 'key1', value: 'value1' }, { key: 'key2', value: 'value2' }];
  has.batchSetStorageSync(kvList);
} catch (err) {
  console.error('batchSetStorageSync error', err);
};

has.batchSetStorage

has.batchSetStorage(Object object): void

异步形式将数据批量存储在本地缓存中指定的key中。

会覆盖掉原来该key对应的内容。除非用户主动删除或因存储空间原因被系统清理，否则数据都一直可用。

单个key允许存储的最大数据长度为1MB，所有数据存储上限为10MB。

起始版本： 1.0.12

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

const kvList = [{ key: 'key1', value: 'value1' }, { key: 'key2', value: 'value2' }];
has.batchSetStorage({
  kvList: kvList,
  success: (res) => {
    console.info('batchSetStorage success', res);
  },
  fail: (err) => {
    console.error('batchSetStorage fail', err);
  },
  complete: (res) => {
    console.info('batchSetStorage complete', res);
  }
});

has.batchGetStorageSync

has.batchGetStorageSync(Array<string> keyList): Array<any>

从本地缓存中同步批量获取指定key的内容。

起始版本： 1.0.12

参数：

返回值：

key对应的内容数组，类型为Array<any>。

错误码信息：

示例：

try {
  const valueList = has.batchGetStorageSync(['key1','key2']);
  if (valueList) {
    // key对应的内容数组：['value1', 'value2']
  }
} catch (err) {
  console.error('batchGetStorageSync error', err);
};

has.batchGetStorage

has.batchGetStorage(Object object): void

异步形式从本地缓存中批量获取指定key的内容。

起始版本： 1.0.12

参数：

参数为Object对象，包括以下字段。

success返回值：

错误码信息：

示例：

has.batchGetStorage({
  keyList: ['key1', 'key2'],
  success: (res) => {
    // res.dataList: ['value1', 'value2']
    console.info('batchGetStorage success', res.dataList);
  },
  fail: (err) => {
    console.error('batchGetStorage fail', err);
  },
  complete: (res) => {
    console.info('batchGetStorage complete', res);
  }
});

has.setBackgroundFetchToken

has.setBackgroundFetchToken(Object object): void

设置自定义登录状态。在数据预拉取请求发起时携带，便于第三方服务器验证请求合法性。

起始版本： 1.0.18

参数：

参数为Object对象，包括以下字段。

错误码信息：

示例：

App({
  onLaunch(opts) {
    has.setBackgroundFetchToken({
      token: 'test_token',
      success: () => {
        console.info('setBackgroundFetchToken success!');
      },
      fail: (err) => {
        console.error('setBackgroundFetchToken fail:', err);
      },
      complete: (res) => {
        console.info('setBackgroundFetchToken complete:', res);
      }
    });
  }
});

has.onBackgroundFetchData

has.onBackgroundFetchData(function listener): void

监听预拉取请求是否完成。如果监听时请求已经完成，则事件不触发。

起始版本： 1.0.18

参数：

callback返回值：

返回的结果包含预拉取类型和缓存数据。

错误码信息：

示例：

App({
  onLaunch(options) {
    has.onBackgroundFetchData((res)=>{
      console.info('onBackgroundFetchData listen success:', res.fetchType); // 预拉取类型
      console.info('onBackgroundFetchData listen success:', res.fetchedData); // 缓存数据
    })
  }
});

has.getBackgroundFetchData

has.getBackgroundFetchData(Object object): void

拉取数据预拉取缓存的数据。当调用接口时，若当前预拉取请求未结束，则获取失败。

起始版本： 1.0.18

参数：

success返回值：

Object类型，包括以下字段：

错误码信息：

示例：

has.getBackgroundFetchData({
  fetchType: 'pre',
  success: (res) => {
    console.info('getBackgroundFetchData success', res);
  },
  fail: (err) => {
    console.error('getBackgroundFetchData fail', err);
  },
  complete: (res) => {
    console.info('getBackgroundFetchData complete', res);
  }
});