universal-asyncstorage

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 universal-asyncstorage --save

Usage

import {setStorage} from 'universal-asyncstorage';

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

| Property | Type | Description | required | Default | | --- | --- | --- | --- | --- | | options | object  | | ✔️ | - | | opthons.key | string  | The specified key in the local cache | ✔️ | - | | opthons.data | object  | Contents to be stored can only be native types, dates, and objects that can be serialized via JSON.stringify. | ✔️ | - | | options.success | Function  | The callback function for a successful API call | ✘ | - | | options.fail | Function  | The callback function for a failed API call | ✘ | - | | options.complete | Function  | The callback function used when the API call completed (always executed whether the call succeeds or fails) | ✘ | - |

setStorageSync(options)

Supported

Arguments

| Property | Type | Description | required | Default | | --- | --- | --- | --- | --- | | options | object  | | ✔️ | - | | opthons.key | string  | The specified key in the local cache | ✔️ | - | | opthons.data | object  | Contents to be stored can only be native types, dates, and objects that can be serialized via JSON.stringify. | ✔️ | - |

getStorage(options)

Supported

Arguments

| Property | Type | Description | required | Default | | --- | --- | --- | --- | --- | | options | object  | | ✔️ | - | | opthons.key | string  | The specified key in the local cache | ✔️ | - | | options.success | Function  | The callback function for a successful API call | ✘ | - | | options.fail | Function  | The callback function for a failed API call | ✘ | - | | options.complete | Function  | The callback function used when the API call completed (always executed whether the call succeeds or fails) | ✘ | - |

Return

| Property | Type | Description | | --- | --- | --- | | data | any  | Content of the key |

getStorageSync(options)

Supported

Arguments

| Property | Type | Description | required | Default | | --- | --- | --- | --- | --- | | options | object  | | ✔️ | - | | opthons.key | string  | The specified key in the local cache | ✔️ | - |

Return

| Property | Type | Description | | --- | --- | --- | | data | any  | Content of the key |

removeStorage(options)

Supported

Arguments

| Property | Type | Description | required | Default | | --- | --- | --- | --- | --- | | options | object  | | ✔️ | - | | opthons.key | string  | The specified key in the local cache | ✔️ | - | | options.success | Function  | The callback function for a successful API call | ✘ | - | | options.fail | Function  | The callback function for a failed API call | ✘ | - | | options.complete | Function  | The callback function used when the API call completed (always executed whether the call succeeds or fails) | ✘ | - |

removeStorageSync(options)

Supported

Arguments

| Property | Type | Description | required | Default | | --- | --- | --- | --- | --- | | options | object  | | ✔️ | - | | opthons.key | string  | The specified key in the local cache | ✔️ | - |