Needle-Pinpointing Machine

    @uni/storage
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.9 • Public • Published

    storage

    npm

    将数据异步存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理,否则数据都一直可用。

    各平台对数据存储大小的限制不同,不建议存储过大的数据,其中支付宝和钉钉小程序单个key允许存储的最大数据大小为 200KB,微信和字节跳动小程序单个 key 允许存储的最大数据长度为 1MB,所有小程序平台总体缓存数据上限均为 10M

    安装

    $ npm install @uni/storage --save

    or

    $ npm install @uni/apis --save

    示例

    import {setStorage} from '@uni/storage';
    
    setStorage({
      key: 'key',
      data: {
        value: 'value'
      },
      success: (res) => {
        console.log('success', res);
      },
      fail: (res) => {
        console.log('fail', res);
      },
      complete: (res) => {
        console.log('complete', res);
      }
    });
    
    // promise
    setStorage({
      key: "key",
      data: {
        value: 'value'
      }
    }).then(response => {})
      .catch(error => {})
      .finally(res => {});

    方法

    setStorage(options)

    支持

    browser miniApp wechatMiniprogram bytedanceMicroApp baiduSmartProgram kuaiShouMiniProgram

    参数

    成员 类型 描述 必选 默认值
    options object  ✔️ -
    options.key string  本地缓存中指定的 key ✔️ -
    options.data object  需要存储的内容。只支持原生类型、Date、及能够通过JSON.stringify序列化的对象。 ✔️ -
    options.success Function  成功的回调 -
    options.fail Function  失败的回调 -
    options.complete Function  结束的回调 (调用成功、失败都会执行) -

    setStorageSync

    npm

    将数据同步存储在本地缓存中指定的 key 中。会覆盖掉原来该 key 对应的内容。除非用户主动删除或因存储空间原因被系统清理,否则数据都一直可用。

    各平台对数据存储大小的限制不同,不建议存储过大的数据,其中支付宝和钉钉小程序单个key允许存储的最大数据大小为 200KB,微信和字节跳动小程序单个 key 允许存储的最大数据长度为 1MB,所有小程序平台总体缓存数据上限均为 10M

    同步数据IO操作可能会影响小程序流畅度,建议使用异步接口,或谨慎处理调用异常。

    安装

    $ npm install @uni/setStorageSync --save

    or

    $ npm install @uni/apis --save

    示例

    import setStorageSync from '@uni/setStorageSync';
    
    setStorageSync({
      key: 'key',
      data: {
        value: 'value'
      }
    });

    方法

    setStorageSync(options)

    支持

    browser miniApp wechatMiniprogram bytedanceMicroApp baiduSmartProgram kuaiShouMiniProgram

    参数

    成员 类型 描述 必选 默认值
    options object  ✔️ -
    options.key string  本地缓存中指定的 key ✔️ -
    options.data object  需要存储的内容。只支持原生类型、Date、及能够通过JSON.stringify序列化的对象。 ✔️ -

    getStorage

    npm

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

    安装

    $ npm install @uni/getStorage --save

    or

    $ npm install @uni/apis --save

    示例

    import getStorage from '@uni/getStorage';
    
    getStorage({
      key: 'key',
      success: (res) => {
        console.log('success', res);
      },
      fail: (res) => {
        console.log('fail', res);
      },
      complete: (res) => {
        console.log('complete', res);
      }
    });
    
    // promise
    getStorage({
      key: "key"
    }).then(response => {})
      .catch(error => {})
      .finally(res => {});

    方法

    getStorage(options)

    支持

    browser miniApp wechatMiniprogram bytedanceMicroApp baiduSmartProgram kuaiShouMiniProgram

    参数

    成员 类型 描述 必选 默认值
    options object  ✔️ -
    options.key string  本地缓存中指定的 key ✔️ -
    options.success Function  成功的回调 -
    options.fail Function  失败的回调 -
    options.complete Function  结束的回调 (调用成功、失败都会执行) -

    返回

    成员 类型 描述
    data any  key对应的内容

    getStorageSync

    npm

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

    安装

    $ npm install @uni/getStorageSync --save

    or

    $ npm install @uni/apis --save

    示例

    import getStorageSync from '@uni/getStorageSync';
    
    let res = getStorageSync({
      key: 'key'
    });

    方法

    getStorageSync(options)

    支持

    browser miniApp wechatMiniprogram bytedanceMicroApp baiduSmartProgram kuaiShouMiniProgram

    参数

    成员 类型 描述 必选 默认值
    options object  ✔️ -
    options.key string  本地缓存中指定的 key ✔️ -

    返回

    成员 类型 描述
    data any  key对应的内容

    removeStorage

    npm

    从本地缓存中异步移除指定 key。

    安装

    $ npm install @uni/removeStorage --save

    or

    $ npm install @uni/apis --save

    示例

    import removeStorage from '@uni/removeStorage';
    
    removeStorage({
      key: 'key',
      success: (res) => {
        console.log('success', res);
      },
      fail: (res) => {
        console.log('fail', res);
      },
      complete: (res) => {
        console.log('complete', res);
      }
    });
    
    // promise
    removeStorage({
      key: "key"
    }).then(response => {})
      .catch(error => {})
      .finally(res => {});

    方法

    removeStorage(options)

    支持

    browser miniApp wechatMiniprogram bytedanceMicroApp baiduSmartProgram kuaiShouMiniProgram

    参数

    成员 类型 描述 必选 默认值
    options object  ✔️ -
    options.key string  本地缓存中指定的 key ✔️ -
    options.success Function  成功的回调 -
    options.fail Function  失败的回调 -
    options.complete Function  结束的回调 (调用成功、失败都会执行) -

    removeStorageSync

    npm

    从本地缓存中同步移除指定 key。

    安装

    $ npm install @uni/removeStorageSync --save

    or

    $ npm install @uni/apis --save

    示例

    import removeStorageSync from '@uni/removeStorageSync';
    
    removeStorageSync({
      key: 'key'
    });

    方法

    removeStorageSync(options)

    支持

    browser miniApp wechatMiniprogram bytedanceMicroApp baiduSmartProgram kuaiShouMiniProgram

    参数

    成员 类型 描述 必选 默认值
    options object  ✔️ -
    options.key string  本地缓存中指定的 key ✔️ -

    Keywords

    none

    Install

    npm i @uni/storage

    DownloadsWeekly Downloads

    9

    Version

    1.0.9

    License

    BSD-3-Clause

    Unpacked Size

    172 kB

    Total Files

    162

    Last publish

    Collaborators

    • bunko
    • rax-publisher