tinybase 5.0.0-beta.26 → 5.0.0-beta.28

package/@types/persisters/persister-sqlite3/with-schemas/index.d.cts

@@ -2,7 +2,7 @@
  * The persister-sqlite3 module of the TinyBase project lets you save and load
  * Store data to and from a local SQLite database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-sqlite3
  * @since v4.0.0
@@ -21,14 +21,15 @@ import type {Database} from 'sqlite3';
 import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.cts';
 
 /**
- * The Sqlite3Persister 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.
+ * The Sqlite3Persister interface represents a Persister that lets you save and
+ * load Store data to and from a local SQLite database.
  *
  * You should use the createSqlite3Persister function to create a
  * Sqlite3Persister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getDb method for accessing a reference to the database instance the
+ * Store is being persisted to.
  * @category Persister
  * @since v4.3.14
  */
@@ -63,8 +64,8 @@ export interface Sqlite3Persister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createSqlite3Persister function creates a Persister object that can
- * persist the Store to a local SQLite database (in an appropriate environment).
+ * The createSqlite3Persister function creates a Sqlite3Persister object that
+ * can persist the Store to a local SQLite database.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -78,6 +79,10 @@ export interface Sqlite3Persister<Schemas extends OptionalSchemas>
  * ): Sqlite3Persister;
  * ```
  *
+ * A Sqlite3Persister supports regular Store objects, and can also be used to
+ * persist the metadata of a MergeableStore when using the JSON serialization
+ * mode, as described below.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `db` parameter which identifies the database instance.
  *
@@ -92,7 +97,7 @@ export interface Sqlite3Persister<Schemas extends OptionalSchemas>
  *
  * See the documentation for the DpcJson and DpcTabular types for more
  * information on how both of those modes can be configured.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param db The database instance that was returned from `new
  * sqlite3.Database(...)`.
  * @param configOrStoreTableName A DatabasePersisterConfig to configure the

package/@types/persisters/persister-sqlite3/with-schemas/index.d.ts

@@ -2,7 +2,7 @@
  * The persister-sqlite3 module of the TinyBase project lets you save and load
  * Store data to and from a local SQLite database (in an appropriate
  * environment).
- * @see Persisting Data guide
+ * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-sqlite3
  * @since v4.0.0
@@ -21,14 +21,15 @@ import type {Database} from 'sqlite3';
 import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.ts';
 
 /**
- * The Sqlite3Persister 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.
+ * The Sqlite3Persister interface represents a Persister that lets you save and
+ * load Store data to and from a local SQLite database.
  *
  * You should use the createSqlite3Persister function to create a
  * Sqlite3Persister object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getDb method for accessing a reference to the database instance the
+ * Store is being persisted to.
  * @category Persister
  * @since v4.3.14
  */
@@ -63,8 +64,8 @@ export interface Sqlite3Persister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createSqlite3Persister function creates a Persister object that can
- * persist the Store to a local SQLite database (in an appropriate environment).
+ * The createSqlite3Persister function creates a Sqlite3Persister object that
+ * can persist the Store to a local SQLite database.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -78,6 +79,10 @@ export interface Sqlite3Persister<Schemas extends OptionalSchemas>
  * ): Sqlite3Persister;
  * ```
  *
+ * A Sqlite3Persister supports regular Store objects, and can also be used to
+ * persist the metadata of a MergeableStore when using the JSON serialization
+ * mode, as described below.
+ *
  * As well as providing a reference to the Store to persist, you must provide a
  * `db` parameter which identifies the database instance.
  *
@@ -92,7 +97,7 @@ export interface Sqlite3Persister<Schemas extends OptionalSchemas>
  *
  * See the documentation for the DpcJson and DpcTabular types for more
  * information on how both of those modes can be configured.
- * @param store The Store to persist.
+ * @param store The Store or MergeableStore to persist.
  * @param db The database instance that was returned from `new
  * sqlite3.Database(...)`.
  * @param configOrStoreTableName A DatabasePersisterConfig to configure the

package/@types/persisters/persister-yjs/index.d.cts

@@ -1,11 +1,11 @@
 /**
  * The persister-yjs module of the TinyBase project provides a way to save and
- * load Store data, to and from a Yjs document.
+ * load Store data to and from a Yjs document.
  *
  * A single entry point, the createYjsPersister function, is provided, which
  * returns a new Persister object that can bind a Store to a provided Yjs
  * document.
- * @see Synchronizing Data guide
+ * @see Third-Party CRDT Persistence guide
  * @packageDocumentation
  * @module persister-yjs
  * @since v4.0.0
@@ -16,13 +16,15 @@ import type {Store} from '../../store/index.d.cts';
 import type {Doc as YDoc} from 'yjs';
 
 /**
- * The YjsPersister interface is a minor extension to the Persister interface.
- *
- * It simply provides an extra getYDoc method for accessing the Yjs document the
- * Store is being persisted to.
+ * The YjsPersister interface represents a Persister that lets you save and load
+ * Store data to and from a Yjs document.
  *
  * You should use the createYjsPersister function to create a YjsPersister
  * object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getYDoc method for accessing the Yjs document the Store is being
+ * persisted to.
  * @category Persister
  * @since v4.3.14
  */
@@ -56,8 +58,11 @@ export interface YjsPersister extends Persister {
 }
 
 /**
- * The createYjsPersister function creates a Persister object that can persist
- * the Store to a Yjs document.
+ * The createYjsPersister function creates a YjsPersister object that can
+ * persist the Store to a Yjs document.
+ *
+ * A YjsPersister only supports regular Store objects, and cannot be used to
+ * persist the metadata of a MergeableStore.
  *
  * As well as providing a reference to the Store to persist, you must provide
  * the Yjs document to persist it to.

package/@types/persisters/persister-yjs/index.d.ts

@@ -1,11 +1,11 @@
 /**
  * The persister-yjs module of the TinyBase project provides a way to save and
- * load Store data, to and from a Yjs document.
+ * load Store data to and from a Yjs document.
  *
  * A single entry point, the createYjsPersister function, is provided, which
  * returns a new Persister object that can bind a Store to a provided Yjs
  * document.
- * @see Synchronizing Data guide
+ * @see Third-Party CRDT Persistence guide
  * @packageDocumentation
  * @module persister-yjs
  * @since v4.0.0
@@ -16,13 +16,15 @@ import type {Store} from '../../store/index.d.ts';
 import type {Doc as YDoc} from 'yjs';
 
 /**
- * The YjsPersister interface is a minor extension to the Persister interface.
- *
- * It simply provides an extra getYDoc method for accessing the Yjs document the
- * Store is being persisted to.
+ * The YjsPersister interface represents a Persister that lets you save and load
+ * Store data to and from a Yjs document.
  *
  * You should use the createYjsPersister function to create a YjsPersister
  * object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getYDoc method for accessing the Yjs document the Store is being
+ * persisted to.
  * @category Persister
  * @since v4.3.14
  */
@@ -56,8 +58,11 @@ export interface YjsPersister extends Persister {
 }
 
 /**
- * The createYjsPersister function creates a Persister object that can persist
- * the Store to a Yjs document.
+ * The createYjsPersister function creates a YjsPersister object that can
+ * persist the Store to a Yjs document.
+ *
+ * A YjsPersister only supports regular Store objects, and cannot be used to
+ * persist the metadata of a MergeableStore.
  *
  * As well as providing a reference to the Store to persist, you must provide
  * the Yjs document to persist it to.

package/@types/persisters/persister-yjs/with-schemas/index.d.cts

@@ -1,11 +1,11 @@
 /**
  * The persister-yjs module of the TinyBase project provides a way to save and
- * load Store data, to and from a Yjs document.
+ * load Store data to and from a Yjs document.
  *
  * A single entry point, the createYjsPersister function, is provided, which
  * returns a new Persister object that can bind a Store to a provided Yjs
  * document.
- * @see Synchronizing Data guide
+ * @see Third-Party CRDT Persistence guide
  * @packageDocumentation
  * @module persister-yjs
  * @since v4.0.0
@@ -19,13 +19,15 @@ import type {Persister} from '../../with-schemas/index.d.cts';
 import type {Doc as YDoc} from 'yjs';
 
 /**
- * The YjsPersister interface is a minor extension to the Persister interface.
- *
- * It simply provides an extra getYDoc method for accessing the Yjs document the
- * Store is being persisted to.
+ * The YjsPersister interface represents a Persister that lets you save and load
+ * Store data to and from a Yjs document.
  *
  * You should use the createYjsPersister function to create a YjsPersister
  * object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getYDoc method for accessing the Yjs document the Store is being
+ * persisted to.
  * @category Persister
  * @since v4.3.14
  */
@@ -60,8 +62,8 @@ export interface YjsPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createYjsPersister function creates a Persister object that can persist
- * the Store to a Yjs document.
+ * The createYjsPersister function creates a YjsPersister object that can
+ * persist the Store to a Yjs document.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -74,6 +76,9 @@ export interface YjsPersister<Schemas extends OptionalSchemas>
  * ): YjsPersister;
  * ```
  *
+ * A YjsPersister only supports regular Store objects, and cannot be used to
+ * persist the metadata of a MergeableStore.
+ *
  * As well as providing a reference to the Store to persist, you must provide
  * the Yjs document to persist it to.
  * @param store The Store to persist.

package/@types/persisters/persister-yjs/with-schemas/index.d.ts

@@ -1,11 +1,11 @@
 /**
  * The persister-yjs module of the TinyBase project provides a way to save and
- * load Store data, to and from a Yjs document.
+ * load Store data to and from a Yjs document.
  *
  * A single entry point, the createYjsPersister function, is provided, which
  * returns a new Persister object that can bind a Store to a provided Yjs
  * document.
- * @see Synchronizing Data guide
+ * @see Third-Party CRDT Persistence guide
  * @packageDocumentation
  * @module persister-yjs
  * @since v4.0.0
@@ -19,13 +19,15 @@ import type {Persister} from '../../with-schemas/index.d.ts';
 import type {Doc as YDoc} from 'yjs';
 
 /**
- * The YjsPersister interface is a minor extension to the Persister interface.
- *
- * It simply provides an extra getYDoc method for accessing the Yjs document the
- * Store is being persisted to.
+ * The YjsPersister interface represents a Persister that lets you save and load
+ * Store data to and from a Yjs document.
  *
  * You should use the createYjsPersister function to create a YjsPersister
  * object.
+ *
+ * It is a minor extension to the Persister interface and simply provides an
+ * extra getYDoc method for accessing the Yjs document the Store is being
+ * persisted to.
  * @category Persister
  * @since v4.3.14
  */
@@ -60,8 +62,8 @@ export interface YjsPersister<Schemas extends OptionalSchemas>
 }
 
 /**
- * The createYjsPersister function creates a Persister object that can persist
- * the Store to a Yjs document.
+ * The createYjsPersister function creates a YjsPersister object that can
+ * persist the Store to a Yjs document.
  *
  * This has schema-based typing. The following is a simplified representation:
  *
@@ -74,6 +76,9 @@ export interface YjsPersister<Schemas extends OptionalSchemas>
  * ): YjsPersister;
  * ```
  *
+ * A YjsPersister only supports regular Store objects, and cannot be used to
+ * persist the metadata of a MergeableStore.
+ *
  * As well as providing a reference to the Store to persist, you must provide
  * the Yjs document to persist it to.
  * @param store The Store to persist.