Repository files navigation

npm install react-native-mmkv-storage

expo prebuild

This library aims to provide a fast & reliable solution for you data storage needs in react-native apps. It usesMMKV 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 ondev.to

Learn how to build your own module with JSI on myblog

Works only with react native 0.71.0 and above. If you are on older version of react native, keep using 0.8.x.

Starting fromv0.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.

(~ 50K Android/30K iOS) and even smaller when packaged.

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 &iOS

Hooks let's the storage update your app when a change takes place in storage.

Starting fromv0.5.5, thanks to the power of JSI, we now have our very ownuseMMKVStorage 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.

import{MMKVLoader,useMMKVStorage}from'react-native-mmkv-storage';conststorage=newMMKVLoader().initialize();constApp=()=>{const[user,setUser]=useMMKVStorage('user',storage,'robert');const[age,setAge]=useMMKVStorage('age',storage,24);return(<Viewstyle={styles.header}><Textstyle={styles.headerText}>        I am{user} and I am{age} years old.</Text></View>);};

Learn more aboutuseMMKVStorage hook it in thedocs.

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.

constApp=()=>{// Get list of all post idsconstpostsIndex=useMMKVStorage("postsIndex",storage,[]);// ['post123','post234'];// Get the posts based on those ids.const[posts,update,remove]=useIndex(postsIndex,"object"storage);return<View><FlatListdata={posts}renderItem={...}></View>}

Learn more aboutuseIndex hook it in thedocs.

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 youbuild custom indexes with a few lines of code.

MMKV.transactions.register('object','beforewrite',({ key, value})=>{if(key.startsWith('post.')){// Call this only when the key has the post prefix.letindexForTag=MMKV.getArray(`${value.tag}-index`)||[];MMKV.setArray(indexForTag.push(key));}});

Learn more about how to use Transactions indocs

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.

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.

constuserStorage=newMMKVLoader().withEncryption().withInstanceID('userdata').initialize();constsettingsStorage=newMMKVLoader().withInstanceID('settings').initialize();

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:

conststorage=newMMKVLoader().withEncryption()// Generates a random key and stores it securely in Keychain.initialize();

And that's it.

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.

Support for redux persist is also added starting from v0.3.2.

You can use this library with expobare workflow.

Thanks topnthach95 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.

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.

• Create a GitHub issue for bug reports, feature requests, or questions
• Follow@ammarahm-ed

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 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

• ospfranco and his work onreact-native-quick-sqlite library which inspired async read/write.

This library is licensed under theMIT license.

Copyright © Ammar Ahmed (@ammarahm-ed)