react-native-modest-storage

💾 react-native-modest-storage 💾

A modest wrapper around the AsyncStorage API

Built with ❤︎ by Tiaan and contributors

Table of Contents

Table of Contents

About

Install

Usage

API

Contribute

License

About

This module is just a modest wrapper around React Native's AsyncStorage API. It's purpose is to provide a cleaner API for persisting data.

Install

$ npm install --save react-native-modest-storage

$ yarn add react-native-modest-storage

Usage

import storage from 'react-native-modest-storage'

async function doStuff() {
  await storage.set('aKey', { Hello: 'World'})
  await storage.set('otherKey', 5)
  await storage.get('aKey').then(console.log) // {Hello: "World"}
  await storage.keys().then(console.log) ["otherKey", "aKey"]
  await storage.update('aKey', {Hello: 'is it me your looking for.'})
  await storage.get('aKey').then(console.log) // {Hello: "is it me your looking for."}
  await storage.remove('otherKey')
  await storage.get('otherKey').then(console.log) // null
  await storage.set([['key1', {foo: 'bar'}], ['key2', 'baz'], ['test', {obj: 9}]])
  await storage.get('key1').then(console.log) // {foo: "bar"}
  await storage.get('test').then(console.log)
  await storage.clear()
}

doStuff()

API

get

Retreive value from AsyncStorage based on key. Wrapper around getItem & multiGet.

Parameters

• key

Returns Promise value of key

set

Persist a value to AsyncStorage. Wrapper around setItem & multiSet.

Parameters

• value Any to persist
• key

Returns Promise

update

Update key with value by merging. Wrapper around mergeItem & multiMerge.

Parameters

• value any to update
• key

Returns Promise

remove

Remove a key from AsyncStorage. Wrapper around removeItem & multiRemove.

Parameters

• key

Returns Promise

clear

Erase all AsyncStorage data.

Returns Promise

keys

Retreive all the keys stored in AsyncStorage of application. Wrapper around getAllKeys

Returns Promise

Contribute

Contributions are welcome. Please open up an issue or create PR if you would like to help out.

Note: If editing the README, please conform to the standard-readme specification.

License

Licensed under the MIT License.