Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fidme/react-native-fast-storage
A simple, performance oriented key value storage for React Native. Drop in replacement for AsyncStorage
https://github.com/fidme/react-native-fast-storage
android asyncstorage ios react-native
Last synced: 30 days ago
JSON representation
A simple, performance oriented key value storage for React Native. Drop in replacement for AsyncStorage
- Host: GitHub
- URL: https://github.com/fidme/react-native-fast-storage
- Owner: FidMe
- Created: 2018-09-26T12:48:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-10-25T15:22:56.000Z (over 3 years ago)
- Last Synced: 2024-12-08T03:51:28.901Z (about 2 months ago)
- Topics: android, asyncstorage, ios, react-native
- Language: Objective-C
- Homepage:
- Size: 465 KB
- Stars: 88
- Watchers: 7
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-native-fast-storage
react-native-fast-storage is a drop in replacement for `AsyncStorage`.
This library is the React Native implementation of https://github.com/Tencent/MMKV.
It provides very fast read and write access.
## Getting started
`$ npm install react-native-fast-storage --save`
`$ react-native link react-native-fast-storage`
**Additional IOS step**
If you encounter this error :
```
ld: warning: Could not find auto-linked framework 'MMKV'
```
You need to manually follow these steps :
- Open up your project in Xcode
- Select the main target (under "Targets"),
- Go to the "Build Settings" tab, and find the "Framework Search Paths" section.
- Add `../node_modules/react-native-fast-storage/ios` (non-recursive) for each of your configurations (e.g. Debug and Release).
- Find the MMKV.framework file in ../node_modules/react-native-fast-storage/ios and drag it into Xcode under the "Frameworks" section. In the dialog that pops up, uncheck "Copy items if needed", choose "Create groups", and ensure your main target is checked under "Add to targets".
- In Xcode, select the project, then select the main target (under "Targets"), then go to the "General" tab and find the "Embedded Binaries" section. Click the "+" icon and select MMKV.framework which appears under "Frameworks" then click "Add".
- In Xcode do "Product" -> "Clean".
## Usage
```javascript
import FastStorage from "react-native-fast-storage";
await FastStorage.setItem("key", "Coucou toi");
const item = await FastStorage.getItem("key");
```
## Methods
All methods are asynchronous, just like AsyncStorage.
| Prop | Params | Returns | Description |
| :---------- | :--------------------------: | :--------------------------: | :------------------------------------ |
| setItem | `key`, `value` | `value` | Allows to set an item |
| getItem | `key` | `value` | Retrieve the item |
| removeItem | `key` | null | Remove an item from the store |
| clearStore | none | null | Clear the entire store |
| multiGet | Array<`key`> | Array> | Retrieve multiples item |
| multiGet | Array> | null | Set multiples items |
| multiRemove | Array<`key`> | null | Remove multiples items from the store |
## multiGet
Get multiple values at once.
```static multiGet(keys: Array): Promise>>```
```js
const values = await FastStorage.multiGet(['test', 'key'])
console.log(values) // [['test', 'testValue'], ['key', 'keyValue']]
```
## multiSet
Set multiple values at once.
```static multiSet(keys: Array>): Promise```
```js
await FastStorage.multiSet([['test', 'testValue'], ['key', 'keyValue']])
```
## multiRemove
Remove multiples values at once.
```static multiRemove(keys: Array): Promise```
```js
await FastStorage.multiRemove(['test', 'key'])
```