initialize method does not return a promise

Install the library

npm install react-native-mmkv-storage

For expo bare workflow

expo prebuild

Get Started with Documentation

What it is

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

Learn how to build your own module with JSI on my blog

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

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.

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 (
    <View style={styles.header}>
      <Text style={styles.headerText}>
        I am {user} and I am {age} years old.
      </Text>
    </View>
  );
};

Learn more about useMMKVStorage hook it in the docs.

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

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 <View>
    <FlatList
    data={posts}
    renderItem={...}
    >
</View>

}

Learn more about useIndex hook it in the docs.

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.

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

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.

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:

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.

Flipper plugin

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

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

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 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 and his work on react-native-quick-sqlite library which inspired async read/write.

License

This library is licensed under the MIT license.

	"peerDependencies": {
	"react-native": "^0.56.3"
	}

ammarahm-ed / react-native-mmkv-storage Goto Github PK

react-native-mmkv-storage's Introduction

Install the library

For expo bare workflow

Get Started with Documentation

What it is

0.9.0 Breaking change

Features

Written in C++ using JSI

Simple and lightweight

Fast and Efficient (0.0002s Read/Write Speed)

Reactive using useMMKVStorage & useIndex Hooks

useMMKVStorage hook

useIndex hook

Lifecycle Control with Transaction Manager

Multi-Process Support

Create unlimited Database instances

Full encryption support

Simple indexer and data querying

Supports redux-persist

Supports expo

Flipper plugin

Consider supporting with a ⭐️ star on GitHub

Contact & Support

I want to contribute

Special thanks to

License

react-native-mmkv-storage's People

Contributors

Stargazers

Watchers

Forkers

react-native-mmkv-storage's Issues

react-native 0.63.2 react-native-mmkv-storage 0.5.2

Recommend Projects

Recommend Topics

Recommend Org

Reactive using `useMMKVStorage` & `useIndex` Hooks

`useMMKVStorage` hook

`useIndex` hook

react-native 0.63.2
react-native-mmkv-storage 0.5.2