@uni/storage v1.0.9

storage

Stores data in the specified key in the local cache. This operation will overwrite the original content of the key. The data storage lifecycle is consistent with the Mini Program, that is, data is always available unless manually deleted by the user or automatically deleted after a certain period of time.

The maximum size of data stored in a single key is 1 MB, and the total size for data storage is limited to 10 MB.

Install

$ npm install @uni/storage --save

or

$ npm install @uni/apis --save

Usage

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 => {});

Methods

setStorage(options)

Supported

Arguments

setStorageSync

Stores data in the specified key in the local cache. This operation will overwrite the original content of the key. The data storage lifecycle is consistent with the Mini Program, that is, data is always available unless manually deleted by the user or automatically deleted after a certain period of time.

The maximum size of data stored in a single key is 1 MB, and the total size for data storage is limited to 10 MB.

Install

$ npm install @uni/setStorageSync --save

or

$ npm install @uni/apis --save

Usage

import setStorageSync from '@uni/setStorageSync';

setStorageSync({
  key: 'key',
  data: {
    value: 'value'
  }
});

Methods

setStorageSync(options)

Supported

Arguments

getStorage

Asynchronously gets the content of the specified key from the local cache.

Install

$ npm install @uni/getStorage --save

or

$ npm install @uni/apis --save

Usage

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 => {});

Methods

getStorage(options)

Supported

Arguments

Return

getStorageSync

Gets the content of the specified key from the local cache.

Install

$ npm install @uni/getStorageSync --save

or

$ npm install @uni/apis --save

Usage

import getStorageSync from '@uni/getStorageSync';

let res = getStorageSync({
  key: 'key'
});

Methods

getStorageSync(options)

Supported

Arguments

Return

removeStorage

Asynchronously removes the specified key from the local cache.

Install

$ npm install @uni/removeStorage --save

or

$ npm install @uni/apis --save

Usage

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 => {});

Methods

removeStorage(options)

Supported

Arguments

removeStorageSync

Removes the specified key from the local cache.

Install

$ npm install @uni/removeStorageSync --save

or

$ npm install @uni/apis --save

Usage

import removeStorageSync from '@uni/removeStorageSync';

removeStorageSync({
  key: 'key'
});

Methods

removeStorageSync(options)

Supported

Arguments