Fast database for react-native with multiple data types support

react-native-mmkv-storage

This library is the React Native wrapper for https://github.com/Tencent/MMKV . which is very fast, efficient and easy to use solution for storing data. This project uses part of code from the original react-native-fast-storage project and allows setting data types other than just strings.

Features

Efficient:MMKV uses mmap to keep memory synced with file, and protobuf to encode/decode values, making the most of iOS/macOS to achieve best performance.

Easy-to-use:You can use MMKV as you go, no configurations needed. All changes are saved immediately, no synchronize calls needed.

Small:A handful of files: MMKV contains encode/decode helpers and mmap logics and nothing more. It's really tidy. Less than 30K in binary size: MMKV adds less than 30K per architecture on App size, and much less when zipped (ipa).

Installation

$ npm install react-native-mmkv-storage --save OR

$ yarn add react-native-mmkv-storage

If you are on [email protected] or below you need to use the following to link the library.

$ react-native link react-native-mmkv-storage

iOS

run pod install inside ios folder.

Storage API

All methods are asynchronous

MMKV.setString(key,value)

Sets a string value in storage for the given key.

Arguments

Name Type key String value String

import MMKV from "react-native-mmkv-storage";

await MMKV.setString("myString", "helloworld");

Returns Promise<boolean>

MMKV.getString(key)

Gets a string value for a given key.

Arguments

Name Type key String

import MMKV from "react-native-mmkv-storage";

let myString = await MMKV.getString("myString");

Returns Promise<string>

MMKV.setInt(key,value)

Sets a number value in storage for the given key.

Arguments

Name Type key String value Number

import MMKV from "react-native-mmkv-storage";

await MMKV.setInt("myNumber", 10);

Returns Promise<boolean>

MMKV.getInt(key)

Gets a number value for a given key.

Arguments

Name Type key String

import MMKV from "react-native-mmkv-storage";

let myNumber = await MMKV.getInt("myNumber");

Returns Promise<number>

MMKV.setBool(key,value)

Sets a boolean value in storage for the given key.

Arguments

Name Type key String value boolean

import MMKV from "react-native-mmkv-storage";

await MMKV.setString("myBooleanValue", false);

Returns Promise<boolean>

MMKV.getBool(key)

Gets a boolean value for a given key.

Arguments

Name Type key String

import MMKV from "react-native-mmkv-storage";

let myBooleanValue = await MMKV.getString("myBooleanValue");

Returns Promise<boolean>

MMKV.setMap(key,value)

Sets an object to storage for the given key.

Arguments

Name Type key String value Object

import MMKV from "react-native-mmkv-storage";

let myObject = { foo: "foo", bar: "bar" };

await MMKV.setMap("myobject", myObject);

Returns Promise<boolean>

MMKV.getMap(key)

Gets an object from storage.

Arguments

Name Type key String

import MMKV from "react-native-mmkv-storage";

let myObject = await MMKV.getMap("myobject");

Returns Promise<object>

MMKV.setArray(key,value)

Sets an array to storage for the given key.

Arguments

Name Type key String value Array

import MMKV from "react-native-mmkv-storage";

let myArray = ["foo", "bar"];

await MMKV.setArray("myArray", myArray);

Returns Promise<boolean>

MMKV.getArray(key)

Sets an array to storage for the given key.

Arguments

Name Type key String

import MMKV from "react-native-mmkv-storage";

let myArray = await MMKV.getArray("myArray");

Returns Promise<Array<>>

MMKV.getMultipleItems([keys])

Retrieve multiple Objects for a given array of keys. Currently will work only if data for all keys is an Object.

Arguments

Name Type keys Array of Keys

import MMKV from "react-native-mmkv-storage";

let multipleItems = await MMKV.getMultipleItems(["foo", "bar", "loo"]);

Returns Promise<Array<object>>

MMKV.hasKey(key)

Check if a key exists in the storage.

Arguments

Name Type key String

import MMKV from "react-native-mmkv-storage";

MMKV.hasKey(key).then(result => {
  if (result) {
    // if true do this.
  } else {
    // if false do this.
  }
});

Returns Promise<boolean>

MMKV.removeItem(key)

Remove an item for a given key.

Arguments

Name Type key String

import MMKV from "react-native-mmkv-storage";

await MMKV.removeItem(key);

MMKV.clearStore()

Clear the storage.

import MMKV from "react-native-mmkv-storage";

await MMKV.clearStore();

Find this library useful? :heart:

Support it by joining stargazers for this repository. :star:️ and follow me for my next creations!

MMKV is Licenced under BSD 3-Clause Licence

This library is MIT Licenced