This package has been deprecated

Author message:

This package has been deprecated and is no longer maintained. Please use @createnextapp/async-local-storage.

local-async-storage

0.0.3 • Public • Published

local-async-storage

LocalAsyncStorage is an unencrypted, asynchronous, persistent, key-value storage system that is global to the app in web browser. It should be used instead of LocalStorage.

NPM npm bundle size

❓ Why LocalAsyncStorage instead of LocalStorage?

Cons of LocalStorage

LocalStorage is synchronous, each local storage operation you run will be one-at-a-time. For complex applications this is a big no-no as it'll slow down your app's runtime.

Pros of LocalAsyncStorage

LocalAsyncStorage is asynchronous, each local async storage operation you run will be multi-at-a-time. It'll speed up your app's runtime.

The LocalAsyncStorage JavaScript code is a facade that provides a clear JavaScript API, real Error objects, and non-multi functions. Each method in the API returns a Promise object.

🔧 Install

local-async-storage is available on npm. It can be installed with the following command:

npm install --save local-async-storage

local-async-storage is available on yarn as well. It can be installed with the following command:

yarn add local-async-storage

💡 Usage

To learn more how to use local-async-storage:

Import

import LocalAsyncStorage from 'local-async-storage'

Store data

storeData = async () => {
  try {
    await LocalAsyncStorage.setItem('@key', 'value')
  } catch(e) {
    // error
  }
}

Read data

readData = async () => {
  let data
 
  try {
    data = await LocalAsyncStorage.getItem('@key')
  } catch(e) {
    // error
  }
 
  console.log(data)
 
  /*
    output: 
    value
  */
}

💖 Wrap Up

If you think any of the local-async-storage can be improved, please do open a PR with any updates and submit any issues. Also, I will continue to improve this, so you might want to watch/star this repository to revisit.

🌟 Contribution

We'd love to have your helping hand on contributions to local-async-storage by forking and sending a pull request!

Your contributions are heartily ♡ welcome, recognized and appreciated. (✿◠‿◠)

How to contribute:

  • Open pull request with improvements
  • Discuss ideas in issues
  • Spread the word
  • Reach out with any feedback

⚖️ License

The MIT License License: MIT

Package Sidebar

Install

npm i local-async-storage

Weekly Downloads

5

Version

0.0.3

License

MIT

Unpacked Size

6.86 kB

Total Files

5

Last publish

Collaborators

  • bunlong