[persisters] ExpoSqlitePersister

Author: jamesgpearce

src/persisters/persister-expo-sqlite.ts

@@ -1,9 +1,12 @@
-import {DatabasePersisterConfig, Persister} from '../types/persisters';
+import {
+  ExpoSqlitePersister,
+  createExpoSqlitePersister as createExpoSqlitePersisterDecl,
+} from '../types/persisters/persister-expo-sqlite';
 import {ResultSet, SQLiteDatabase} from 'expo-sqlite';
 import {UpdateListener, createSqlitePersister} from './sqlite/create';
+import {DatabasePersisterConfig} from '../types/persisters';
 import {IdObj} from '../common/obj';
 import {Store} from '../types/store';
-import {createExpoSqlitePersister as createExpoSqlitePersisterDecl} from '../types/persisters/persister-expo-sqlite';
 
 type Subscription = {remove: () => void};
 
@@ -13,7 +16,7 @@ export const createExpoSqlitePersister = ((
   configOrStoreTableName?: DatabasePersisterConfig | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,
   onIgnoredError?: (error: any) => void,
-): Persister =>
+): ExpoSqlitePersister =>
   createSqlitePersister(
     store,
     configOrStoreTableName,
@@ -25,4 +28,4 @@ export const createExpoSqlitePersister = ((
     onSqlCommand,
     onIgnoredError,
     db,
-  )) as typeof createExpoSqlitePersisterDecl;
+  ) as ExpoSqlitePersister) as typeof createExpoSqlitePersisterDecl;

src/types/docs/persisters/persister-expo-sqlite.js

@@ -11,6 +11,39 @@
  * @since v4.0.3
  */
 /// persister-expo-sqlite
+/**
+ * The ExpoSqlitePersister interface is a minor extension to the Persister
+ * interface.
+ *
+ * It simply provides an extra getDb method for accessing a reference to the
+ * database instance the Store is being persisted to.
+ * @since v4.3.14
+ */
+/// ExpoSqlitePersister
+{
+  /**
+   * The getDb method returns a reference to the database instance the Store is
+   * being persisted to.
+   * @returns A reference to the database instance.
+   * @example
+   * This example creates a Persister object against a newly-created Store and
+   * then gets the database instance back out again.
+   *
+   * ```js yolo
+   * const db = SQLite.openDatabase('my.db');
+   * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
+   * const persister = createExpoSqlitePersister(store, db, 'my_tinybase');
+   *
+   * console.log(persister.getDb() == db);
+   * // -> true
+   *
+   * persister.destroy();
+   * ```
+   * @category Getter
+   * @since v4.3.14
+   */
+  /// ExpoSqlitePersister.getDb
+}
 /**
  * The createExpoSqlitePersister function creates a Persister object that can
  * persist the Store to a local Expo-SQLite database (in an appropriate React
@@ -45,11 +78,11 @@
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
  * debugging persistence issues in a development environment, since v4.0.4.
- * @returns A reference to the new Persister object.
+ * @returns A reference to the new ExpoSqlitePersister object.
  * @example
- * This example creates a Persister object and persists the Store to a local
- * SQLite database as a JSON serialization into the `my_tinybase` table. It
- * makes a change to the database directly and then reloads it back into the
+ * This example creates a ExpoSqlitePersister object and persists the Store to a
+ * local SQLite database as a JSON serialization into the `my_tinybase` table.
+ * It makes a change to the database directly and then reloads it back into the
  * Store.
  *
  * ```js yolo
@@ -81,8 +114,8 @@
  * persister.destroy();
  * ```
  * @example
- * This example creates a Persister object and persists the Store to a local
- * SQLite database with tabular mapping.
+ * This example creates a ExpoSqlitePersister object and persists the Store to a
+ * local SQLite database with tabular mapping.
  *
  * ```js yolo
  * const db = SQLite.openDatabase('my.db');

src/types/persisters/persister-expo-sqlite.d.ts

@@ -4,11 +4,17 @@ import {DatabasePersisterConfig, Persister} from '../persisters';
 import {SQLiteDatabase} from 'expo-sqlite';
 import {Store} from '../store';
 
+/// ExpoSqlitePersister
+export interface ExpoSqlitePersister extends Persister {
+  /// ExpoSqlitePersister.getDb
+  getDb: () => SQLiteDatabase;
+}
+
 /// createExpoSqlitePersister
 export function createExpoSqlitePersister(
   store: Store,
   db: SQLiteDatabase,
   configOrStoreTableName?: DatabasePersisterConfig | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,
   onIgnoredError?: (error: any) => void,
-): Persister;
+): ExpoSqlitePersister;

src/types/with-schemas/persisters/persister-expo-sqlite.d.ts

@@ -4,11 +4,18 @@ import {DatabasePersisterConfig, Persister} from '../persisters';
 import {OptionalSchemas, Store} from '../store';
 import {SQLiteDatabase} from 'expo-sqlite';
 
+/// ExpoSqlitePersister
+export interface ExpoSqlitePersister<Schemas extends OptionalSchemas>
+  extends Persister<Schemas> {
+  /// ExpoSqlitePersister.getDb
+  getDb: () => SQLiteDatabase;
+}
+
 /// createExpoSqlitePersister
 export function createExpoSqlitePersister<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,
   db: SQLiteDatabase,
   configOrStoreTableName?: DatabasePersisterConfig<Schemas> | string,
   onSqlCommand?: (sql: string, args?: any[]) => void,
   onIgnoredError?: (error: any) => void,
-): Persister<Schemas>;
+): ExpoSqlitePersister<Schemas>;