Add docs

Author: ospfranco

docs/docs/api.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 8
+sidebar_position: 9
 ---
 
 # API Reference

docs/docs/key_value_storage.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 8
+---
+
+# Key-Value Storage
+
+OP-SQLite provides a simple key-value storage API compatible with react-native-async-storage. It should be much faster than async-storage (whilst slower than MMKV) but comes with the convenience of not having to add one more dependency to your app. For convenience it also has sync versions of the methods. If you use SQLCipher the data inside will also be encrypted.
+
+```ts
+import { Storage } from '@op-engineering/op-sqlite';
+
+// Storage is backed by it's own database
+// You can set the location like any other op-sqlite database
+const storage = new Storage({
+  location: 'storage', // Optional, see location param on normal databases
+  encryptionKey: 'myEncryptionKey', // Optional, only used when used against SQLCipher
+});
+
+const item = storage.getItemSync('foo');
+
+const item2 = await storage.getItem('foo');
+
+await storage.setItem('foo', 'bar');
+
+storage.setItemSync('foo', 'bar');
+
+const allKeys = storage.getAllKeys();
+
+// Clears the internal table
+storage.clear();
+```

src/Storage.ts

@@ -16,39 +16,48 @@ export class Storage {
     this.db = open({ ...options, name: '__opsqlite_storage' });
     this.db.executeSync('PRAGMA mmap_size=268435456');
     this.db.executeSync(
-      'CREATE TABLE IF NOT EXISTS storage (key TEXT PRIMARY KEY, value TEXT) STRICT'
+      'CREATE TABLE IF NOT EXISTS storage (key TEXT PRIMARY KEY, value TEXT) STRICT WITHOUT ROWID'
     );
   }
 
-  async getItem(key: string) {
+  async getItem(key: string): Promise<string | undefined> {
     const result = await this.db.execute(
       'SELECT value FROM storage WHERE key = ?',
       [key]
     );
 
-    return result.rows[0]?.value;
+    let value = result.rows[0]?.value;
+    if (typeof value !== 'undefined' && typeof value !== 'string') {
+      throw new Error('Value must be a string or undefined');
+    }
+    return value;
   }
 
-  getItemSync(key: string) {
+  getItemSync(key: string): string | undefined {
     const result = this.db.executeSync(
       'SELECT value FROM storage WHERE key = ?',
       [key]
     );
 
-    return result.rows[0]?.value;
+    let value = result.rows[0]?.value;
+    if (typeof value !== 'undefined' && typeof value !== 'string') {
+      throw new Error('Value must be a string or undefined');
+    }
+
+    return value;
   }
 
   async setItem(key: string, value: string) {
     await this.db.execute(
       'INSERT OR REPLACE INTO storage (key, value) VALUES (?, ?)',
-      [key, value]
+      [key, value.toString()]
     );
   }
 
   setItemSync(key: string, value: string) {
     this.db.executeSync(
       'INSERT OR REPLACE INTO storage (key, value) VALUES (?, ?)',
-      [key, value]
+      [key, value.toString()]
     );
   }
 
@@ -67,4 +76,10 @@ export class Storage {
   clearSync() {
     this.db.executeSync('DELETE FROM storage');
   }
+
+  getAllKeys() {
+    return this.db
+      .executeSync('SELECT key FROM storage')
+      .rows.map((row: any) => row.key);
+  }
 }

src/index.ts

@@ -1,4 +1,5 @@
 import { NativeModules, Platform } from 'react-native';
+export { Storage } from './Storage';
 
 export type Scalar =
   | string