Merge pull request #81 from mateosilguero/master

Type Callback Function

Author: ammarahm-ed

example/App.tsx

@@ -0,0 +1,69 @@
+import React, {useEffect, useState} from 'react';
+import {
+  SafeAreaView,
+  StyleSheet,
+  ScrollView,
+  Text,
+  StatusBar,
+} from 'react-native';
+import MMKV from 'react-native-mmkv-storage';
+
+const MMKVStorage = new MMKV.Loader().withEncryption().initialize();
+
+interface StoredMap {
+  name: string;
+  date: number;
+}
+
+const App = () => {
+  const [stringValue, setStringValue] = useState('');
+  const [arrayValue, setArrayValue] = useState<Array<undefined>>([]);
+  const [mapValue, setMapValue] = useState<StoredMap>({
+    name: '',
+    date: Date.now(),
+  });
+
+  useEffect(() => {
+    const map = MMKVStorage.getMap<StoredMap>('map');
+    map && setMapValue(map);
+    MMKVStorage.removeItem('map');
+    MMKVStorage.setMap('map', {
+      name: 'AAA',
+      date: Date.now(),
+    });
+    const randomString = MMKVStorage.getString('random-string');
+    randomString && setStringValue(randomString);
+    MMKVStorage.setString(
+      'random-string',
+      Math.random().toString(36).substring(7),
+    );
+    const array = MMKVStorage.getArray<undefined>('array');
+    array && setArrayValue(array);
+    MMKVStorage.setArray('array', new Array(16).fill(undefined));
+  }, []);
+
+  return (
+    <>
+      <StatusBar barStyle="dark-content" />
+      <SafeAreaView>
+        <ScrollView
+          contentInsetAdjustmentBehavior="automatic"
+          style={styles.scrollView}>
+          <Text>Previous value: {stringValue}</Text>
+          <Text>
+            Map value: {mapValue?.name} {mapValue?.date}
+          </Text>
+          <Text>Array Length: {arrayValue?.length}</Text>
+        </ScrollView>
+      </SafeAreaView>
+    </>
+  );
+};
+
+const styles = StyleSheet.create({
+  scrollView: {
+    padding: 32,
+  },
+});
+
+export default App;

example/tsconfig.json

@@ -0,0 +1,27 @@
+{
+    "compilerOptions": {
+        "allowJs": true,
+        "allowSyntheticDefaultImports": true,
+        "esModuleInterop": true,
+        "isolatedModules": true,
+        "jsx": "react",
+        "lib": [
+            "es6"
+        ],
+        "moduleResolution": "node",
+        "noEmit": true,
+        "strict": true,
+        "target": "esnext",
+        "paths": {
+            "react-native-mmkv-storage": [
+                "../index.d.ts"
+            ]
+        }
+    },
+    "exclude": [
+        "node_modules",
+        "babel.config.js",
+        "metro.config.js",
+        "jest.config.js"
+    ]
+}

index.d.ts

@@ -17,6 +17,8 @@ type MODES = {
   MULTI_PROCESS: number;
 };
 
+type Callback<T> = (error: Error | null, result: T | null) => void;
+
 declare module MMKVStorage {
   export const MODES: MODES;
 
@@ -25,10 +27,8 @@ declare module MMKVStorage {
   const myVar: string;
 
   class API {
-
-
-     /**
-     * Set a string value to storage for a given key. 
+    /**
+     * Set a string value to storage for a given key.
      * This method is added for redux-persist support. It is similar to setStringAsync()
      *
      * @param {String} key
@@ -43,7 +43,6 @@ declare module MMKVStorage {
      */
     getItem(key: string): Promise<string>;
 
-
     /**
      * Set a string value to storag for a given key.
      *
@@ -101,7 +100,7 @@ declare module MMKVStorage {
      * Get an Object from storage for a given key.
      * @param {String} key
      */
-    getMapAsync(key: string): Promise<object | null>;
+    getMapAsync<T extends object>(key: string): Promise<T | null>;
     /**
      * Set an array to the db.
      * @param {String} key
@@ -113,7 +112,7 @@ declare module MMKVStorage {
      * @param {String} key
      */
 
-    getArrayAsync(key: string): Promise<Array<any> | null>;
+    getArrayAsync<T extends any>(key: string): Promise<Array<T> | null>;
     /**
      * Retrieve multiple Objects for a given array of keys. Currently will work only if data for all keys is an Object.
      * Arrays will also be returned but wrappen in a object.
@@ -122,7 +121,9 @@ declare module MMKVStorage {
      *
      * @param {Array} keys
      */
-    getMultipleItemsAsync(keys: Array<string>): Promise<Array<object>>;
+    getMultipleItemsAsync<T extends object>(
+      keys: Array<string>
+    ): Promise<Array<T>>;
 
     clearStore(): Promise<boolean>;
     /**
@@ -139,87 +140,96 @@ declare module MMKVStorage {
      *
      * @param {String} key
      * @param {String} value
-     * @param {Function} callback
+     * @param {Callback<boolean>} callback
      */
-    setString(key: string, value: string, callback?: Function): null;
+    setString(key: string, value: string, callback?: Callback<boolean>): null;
     /**
      * Get a string value for a given key.
      * @param {String} key
-     * @param {Function} callback
+     * @param {Callback<string>} callback
      */
-    getString(key: string, callback?: Function): string | null;
+    getString(key: string, callback?: Callback<string>): string | null;
 
     /**
      * Set a number value to storage for a given key.
      *
      * @param {String} key
      * @param {number} value
-     * @param {Function} callback
+     * @param {Callback<boolean>} callback
      */
-    setInt(key: string, value: number, callback?: Function): null;
+    setInt(key: string, value: number, callback?: Callback<boolean>): null;
 
     /**
      * Get a number value for a given key
      * @param {String} key
-     * @param {Function} callback
+     * @param {Callback<number>} callback
      */
-    getInt(key: string, callback?: Function): number | null;
+    getInt(key: string, callback?: Callback<number>): number | null;
 
     /**
      * Set a boolean value to storag for a given key.
      *
      * @param {String} key
      * @param {boolean} value
-     * @param {Function} callback
+     * @param {Callback<boolean>} callback
      */
-    setBool(key: string, value: boolean, callback?: Function): null;
+    setBool(key: string, value: boolean, callback?: Callback<boolean>): null;
 
     /**
      * Get a boolean value for a given key.
      * @param {String} key
-     * @param {Function} callback
+     * @param {Callback<boolean>} callback
      */
-    getBool(key: string, callback?: Function): boolean | null;
+    getBool(key: string, callback?: Callback<boolean>): boolean | null;
 
     /**
      * Set an Object to storage for a given key.
      *
      * @param {String} key
      * @param {Object} value
-     * @param {Function} callback
+     * @param {Callback<boolean>} callback
      */
 
-    setMap(key: string, value: object, callback?: Function): null;
+    setMap(key: string, value: object, callback?: Callback<boolean>): null;
     /**
      * Get an Object from storage for a given key.
      * @param {String} key
-     * @param {Function} callback
+     * @param {Callback<object>} callback
      */
-    getMap(key: string, callback?: Function): object | null;
+    getMap<T extends object>(key: string, callback?: Callback<T>): T | null;
     /**
      * Set an array to the db.
      * @param {String} key
      * @param {Array} array
-     * @param {Function} callback
+     * @param {Callback<boolean>} callback
      */
-    setArray(key: string, value: Array<any>, callback?: Function): null;
+    setArray(
+      key: string,
+      value: Array<any>,
+      callback?: Callback<boolean>
+    ): null;
     /**
      * get an array from the storage for give key.
      * @param {String} key
-     * @param {Function} callback
+     * @param {Array<any>} callback
      */
-
-    getArray(key: string, callback?: Function): Array<any> | null;
+    getArray<T extends any>(
+      key: string,
+      callback?: Callback<Array<T>>
+    ): Array<T> | null;
     /**
      * Retrieve multiple Objects for a given array of keys. Currently will work only if data for all keys is an Object.
      * Arrays will also be returned but wrappen in a object.
      *
      * **Will not work if a key as a String value.**
      *
      * @param {Array} keys
-     * @param {Function} callback
+     * @param {Array<object>} callback
      */
-    getMultipleItems(keys: Array<string>, callback?: Function): Array<object>;
+    getMultipleItems<T extends object>(
+      keys: Array<string>,
+      callback?: Callback<Array<T>>
+    ): Array<T>;
 
     /**
      *
@@ -378,7 +388,7 @@ declare module MMKVStorage {
       key: string,
       secureKeyStorage: boolean,
       alias: string,
-      accessibleMode:ACCESSIBLE
+      accessibleMode: ACCESSIBLE
     ): Promise<boolean>;
 
     /**
@@ -400,7 +410,7 @@ declare module MMKVStorage {
       key: string,
       secureKeyStorage: boolean,
       alias: string,
-      accessibleMode:ACCESSIBLE
+      accessibleMode: ACCESSIBLE
     ): Promise<boolean>;
   }
 
@@ -429,14 +439,14 @@ declare module MMKVStorage {
     setAccessibleIOS(accessible: ACCESSIBLE): this;
 
     /**
-    * Provide a custom key to encrypt the storage. Use this if you dont want to generate the key automatically.
-    * You must call withEncryption() to use this.
-    * To store your key for later use call withSecureKeyStorage() too.
-    *
-    * @param {string} key the key to encrypt the storage with
-    * @param {boolean} secureKeyStorage Should the key be stored securely.
-    * @param {string} alias Provide an alias for key storage. Default alias is aliasPrefix + instanceID
-    */
+     * Provide a custom key to encrypt the storage. Use this if you dont want to generate the key automatically.
+     * You must call withEncryption() to use this.
+     * To store your key for later use call withSecureKeyStorage() too.
+     *
+     * @param {string} key the key to encrypt the storage with
+     * @param {boolean} secureKeyStorage Should the key be stored securely.
+     * @param {string} alias Provide an alias for key storage. Default alias is aliasPrefix + instanceID
+     */
 
     encryptWithCustomKey(
       key: string,