Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ammarahm-ed/react-native-mmkv-storage
An ultra fast (0.0002s read/write), small & encrypted mobile key-value storage framework for React Native written in C++ using JSI
https://github.com/ammarahm-ed/react-native-mmkv-storage
android asyncstorage data-storage database encryption expo fast fast-storage ios java mmap mmkv mmkv-database native objective-c react react-native react-native-jsi storage
Last synced: 22 days ago
JSON representation
An ultra fast (0.0002s read/write), small & encrypted mobile key-value storage framework for React Native written in C++ using JSI
- Host: GitHub
- URL: https://github.com/ammarahm-ed/react-native-mmkv-storage
- Owner: ammarahm-ed
- License: mit
- Created: 2020-03-10T15:23:29.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-18T18:52:03.000Z (about 2 months ago)
- Last Synced: 2024-10-19T23:24:56.636Z (24 days ago)
- Topics: android, asyncstorage, data-storage, database, encryption, expo, fast, fast-storage, ios, java, mmap, mmkv, mmkv-database, native, objective-c, react, react-native, react-native-jsi, storage
- Language: C++
- Homepage: https://rnmmkv.now.sh
- Size: 4.08 MB
- Stars: 1,591
- Watchers: 15
- Forks: 111
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
#
Install the library
npm install react-native-mmkv-storage
For expo bare workflow
expo prebuild
## What it is
This library aims to provide a fast & reliable solution for you data storage needs in react-native apps. It uses [MMKV](https://github.com/Tencent/MMKV) by Tencent under the hood on Android and iOS both that is used by their WeChat app(more than 1 Billion users). Unlike other storage solutions for React Native, this library lets you store any kind of data type, in any number of database instances, with or without encryption in a very fast and efficient way. Read about it on this blog post I wrote on [dev.to](https://dev.to/ammarahmed/best-data-storage-option-for-react-native-apps-42k)
> Learn how to build your own module with JSI on my [blog](https://blog.notesnook.com/getting-started-react-native-jsi/)
## 0.9.0 Breaking change
Works only with react native 0.71.0 and above. If you are on older version of react native, keep using 0.8.x.
## Features
### **Written in C++ using JSI**
Starting from `v0.5.0` the library has been rewritten in C++ on Android and iOS both. It employs React Native JSI making it the fastest storage option for React Native.
### **Simple and lightweight**
(~ 50K Android/30K iOS) and even smaller when packaged.
### **Fast and Efficient (0.0002s Read/Write Speed)**
MMKV uses mmap to keep memory synced with file, and protobuf to encode/decode values to achieve best performance.
You can see the benchmarks here: [Android](https://github.com/Tencent/MMKV/wiki/android_benchmark) & [iOS](https://github.com/Tencent/MMKV/wiki/iOS_benchmark)
### **Reactive using `useMMKVStorage` & `useIndex` Hooks**
Hooks let's the storage update your app when a change takes place in storage.
#### `useMMKVStorage` hook
Starting from `v0.5.5`, thanks to the power of JSI, we now have our very own `useMMKVStorage` Hook. Think of it like a persisted state that will always write every change in storage and update your app UI instantly. It doesn't matter if you reload the app or restart it.
```js
import { MMKVLoader, useMMKVStorage } from 'react-native-mmkv-storage';
const storage = new MMKVLoader().initialize();
const App = () => {
const [user, setUser] = useMMKVStorage('user', storage, 'robert');
const [age, setAge] = useMMKVStorage('age', storage, 24);
return (
I am {user} and I am {age} years old.
);
};
```
Learn more about `useMMKVStorage` hook it in the [docs](https://rnmmkv.vercel.app/#/usemmkvstorage).
#### `useIndex` hook
A hook that will take an array of keys and returns an array of values for those keys. This is supposed to work in combination with Transactions. When you have build your custom index, you will need an easy and quick way to load values for your index. useIndex hook actively listens to all read/write changes and updates the values accordingly.
```js
const App = () => {
// Get list of all post ids
const postsIndex = useMMKVStorage("postsIndex",storage,[]); // ['post123','post234'];
// Get the posts based on those ids.
const [posts,update,remove] = useIndex(postsIndex,"object" storage);
return
}
```
Learn more about `useIndex` hook it in the [docs](https://rnmmkv.vercel.app/#/useindex).
### **Lifecycle Control with Transaction Manager**
Listen to a value's lifecycle and mutate it on the go. Transactions lets you register lifecycle functions with your storage instance such as Read, Write and Delete. This allows for a better and more managed control over the storage and also let's you **build custom indexes** with a few lines of code.
```js
MMKV.transactions.register('object', 'beforewrite', ({ key, value }) => {
if (key.startsWith('post.')) {
// Call this only when the key has the post prefix.
let indexForTag = MMKV.getArray(`${value.tag}-index`) || [];
MMKV.setArray(indexForTag.push(key));
}
});
```
Learn more about how to use Transactions in [docs](https://rnmmkv.vercel.app/#/transactionmanager)
### **Multi-Process Support**
MMKV supports concurrent read-read and read-write access between processes. This means that you can use MMKV for various extensions and widgets and your app.
### **Create unlimited Database instances**
You can create many database instances. This helps greatly if you have separate logics/modules in the same app that use data differently, It also helps in better performance since each database instance is small instead of a single bulky database which makes things slower as it grows.
```js
const userStorage = new MMKVLoader().withEncryption().withInstanceID('userdata').initialize();
const settingsStorage = new MMKVLoader().withInstanceID('settings').initialize();
```
### **Full encryption support**
The library supports full encryption (AES CFB-128) on Android and iOS. You can choose to store your encryption key securely for continuious usage. The library uses Keychain on iOS and Android Keystore on android (API 23 and above). Encrypting an instance is simple:
```js
const storage = new MMKVLoader()
.withEncryption() // Generates a random key and stores it securely in Keychain
.initialize();
```
And that's it.
### **Simple indexer and data querying**
For each database instance, there is one global key index and then there are indexes of each type of data. So querying is easy and fast.
### **Supports redux-persist**
Support for redux persist is also added starting from v0.3.2.
### **Supports expo**
You can use this library with expo [bare workflow](https://docs.expo.dev/workflow/customizing/).
### **Flipper plugin**
Thanks to [pnthach95](https://github.com/pnthach95/flipper-plugin-react-native-mmkv-storage/commits?author=pnthach95) Flipper plugin is finally here. https://github.com/pnthach95/flipper-plugin-react-native-mmkv-storage. It supports logging and manipulating storage values on the fly.
## Consider supporting with a ⭐️ [star on GitHub](https://github.com/ammarahm-ed/react-native-mmkv-storage/)
If you are using the library in one of your projects, consider supporting with a star. It takes a lot of time and effort to keep this maintained and address issues and bugs. Thank you.
## Contact & Support
- Create a GitHub issue for bug reports, feature requests, or questions
- Follow [@ammarahm-ed](https://github.com/ammarahm-ed)
## I want to contribute
That is awesome news! There is a lot happening at a very fast pace in this library right now. Every little help is precious. You can contribute in many ways:
- Suggest code improvements on native iOS and Android
- If you have suggestion or idea you want to discuss, open an issue.
- [Open an issue](https://github.com/ammarahm-ed/react-native-mmkv-storage/issues/) if you want to make a pull request, and tell me what you want to improve or add so we can discuss
- I am always open to new ideas
## Special thanks to
- [ospfranco](https://github.com/ospfranco) and his work on [react-native-quick-sqlite](https://github.com/ospfranco/react-native-quick-sqlite) library which inspired async read/write.
## License
This library is licensed under the [MIT license](https://github.com/ammarahm-ed/react-native-mmkv-storage/blob/master/LICENSE).
Copyright © Ammar Ahmed ([@ammarahm-ed](https://github.com/ammarahm-ed))
#
