💾 react-native-modest-storage 💾
A modest wrapper around the AsyncStorage API
Table of Contents
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
This project uses node and npm.
$ npm install react-native-modest-storage$ # OR $ yarn add react-native-modest-storage
Usage
{ await storage await storage await storage // {Hello: "World"} await storage // ['otherKey', 'aKey'] await storage await storage // {Hello: "is it me your looking for."} await storage await storage // null await storage await storage // {foo: "bar"} await storage await storageclear}
API
Table of Contents
get
Retreive value from AsyncStorage based on key. Wrapper around getItem & multiGet.
Parameters
key
def
Any Default value
Examples
storage
Returns Promise value of key
set
Persist a value to AsyncStorage. Wrapper around setItem & multiSet.
Parameters
key
value
Any to persist
Returns Promise
update
Update key with value by merging. Wrapper around mergeItem & multiMerge.
Parameters
key
value
any to update
Returns Promise
remove
Remove a key from AsyncStorage. Wrapper around removeItem & multiRemove.
Parameters
key
Examples
storage
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
- Fork it and create your feature branch: git checkout -b my-new-feature
- Commit your changes: git commit -am 'Add some feature'
- Push to the branch: git push origin my-new-feature
- Submit a pull request
License
MIT