tinybase 5.0.0-beta.24 → 5.0.0-beta.26

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

@@ -54,46 +54,66 @@ import type {
 import type {TableIdFromSchema} from '../../_internal/store/with-schemas/index.d.ts';
 
 /**
- * The StoreTypes type
+ * The Persists enum.
+ *
+ * This is used to indicate what types of Store a Persister can support.
+ * @category Mergeable
+ * @since v5.0.0
  */
-export type StoreTypes =
-  | 1 // Store only
-  | 2 // MergeableStore only
-  | 3; // Store and MergeableStore
+export const enum Persists {
+  /**
+   * The StoreOnly enum value.
+   */
+  StoreOnly = 1,
+  /**
+   * The MergeableStoreOnly enum value.
+   */
+  MergeableStoreOnly = 2,
+  /**
+   * The StoreOrMergeableStore enum value.
+   */
+  StoreOrMergeableStore = 3,
+}
 
 /**
- * The PersistedStore type
+ * The PersistedStore type.
+ * @category Mergeable
+ * @since v5.0.0
  */
 export type PersistedStore<
   Schemas extends OptionalSchemas,
-  StoreType extends StoreTypes = 1,
-> = StoreType extends 3
+  Persist extends Persists = Persists.StoreOnly,
+> = Persist extends Persists.StoreOrMergeableStore
   ? Store<Schemas> | MergeableStore<Schemas>
-  : StoreType extends 2
+  : Persist extends Persists.MergeableStoreOnly
     ? MergeableStore<Schemas>
     : Store<Schemas>;
 
 /**
- * The PersistedContent type
+ * The PersistedContent type.
+ * @category Mergeable
+ * @since v5.0.0
  */
 export type PersistedContent<
   Schemas extends OptionalSchemas,
-  StoreType extends StoreTypes = 1,
-> = StoreType extends 3
+  Persist extends Persists = Persists.StoreOnly,
+> = Persist extends Persists.StoreOrMergeableStore
   ? Content<Schemas> | MergeableContent<Schemas>
-  : StoreType extends 2
+  : Persist extends Persists.MergeableStoreOnly
     ? MergeableContent<Schemas>
     : Content<Schemas>;
 
 /**
- * The PersistedChanges type
+ * The PersistedChanges type.
+ * @category Mergeable
+ * @since v5.0.0
  */
 export type PersistedChanges<
   Schemas extends OptionalSchemas,
-  StoreType extends StoreTypes = 1,
-> = StoreType extends 3
+  Persist extends Persists = Persists.StoreOnly,
+> = Persist extends Persists.StoreOrMergeableStore
   ? Changes<Schemas> | MergeableChanges<Schemas>
-  : StoreType extends 2
+  : Persist extends Persists.MergeableStoreOnly
     ? MergeableChanges<Schemas>
     : Changes<Schemas>;
 
@@ -104,9 +124,9 @@ export type PersistedChanges<
  * This has schema-based typing. The following is a simplified representation:
  *
  * ```ts override
- * export type PersisterListener<StoreType extends StoreTypes = 1> = (
- *   content?: PersistedContent<StoreType>,
- *   changes?: PersistedChanges<StoreType>,
+ * export type PersisterListener<Persist extends Persists = Persists.StoreOnly> = (
+ *   content?: PersistedContent<Persist>,
+ *   changes?: PersistedChanges<Persist>,
  * ) => void;
  * ```
  *
@@ -125,18 +145,17 @@ export type PersistedChanges<
  */
 export type PersisterListener<
   Schemas extends OptionalSchemas,
-  StoreType extends StoreTypes = 1,
+  Persist extends Persists = Persists.StoreOnly,
 > = (
-  content?: PersistedContent<Schemas, StoreType>,
-  changes?: PersistedChanges<Schemas, StoreType>,
+  content?: PersistedContent<Schemas, Persist>,
+  changes?: PersistedChanges<Schemas, Persist>,
 ) => void;
 
 /**
  * The PersisterStats type describes the number of times a Persister object has
  * loaded or saved data.
  *
- * A PersisterStats object is returned from the getStats method, and is only
- * populated in a debug build.
+ * A PersisterStats object is returned from the getStats method.
  * @category Development
  */
 export type PersisterStats = {
@@ -232,7 +251,7 @@ export type DatabasePersisterConfig<Schemas extends OptionalSchemas> =
  * called `_id`, and one called `store`. (These column names can be changed
  * using the `rowIdColumnName` and `storeColumnName` settings). The Persister
  * will place a single row in this table with `_` in the `_id` column, and the
- * JSON serialization in the `store` column, something like:
+ * JSON serialization in the `store` column, something like the following.
  *
  * ```
  * > SELECT * FROM tinybase;
@@ -307,7 +326,7 @@ export type DpcJson = {
  *
  * Note that if you are planning to both load from and save to a database, it is
  * important to make sure that the load and save table mappings are symmetrical.
- * For example:
+ * For example, consider the following.
  *
  * ```js
  * import type {DatabasePersisterConfig} from 'tinybase';
@@ -751,7 +770,7 @@ export type DpcTabularValues = {
  */
 export interface Persister<
   in out Schemas extends OptionalSchemas,
-  StoreType extends StoreTypes = 1,
+  Persist extends Persists = Persists.StoreOnly,
 > {
   /**
    * The load method gets persisted data from storage, and loads it into the
@@ -1165,7 +1184,7 @@ export interface Persister<
    * This has schema-based typing. The following is a simplified representation:
    *
    * ```ts override
-   * getStore(): PersistedStore<StoreType>;
+   * getStore(): PersistedStore<Persist>;
    * ```
    *
    * ```js
@@ -1184,7 +1203,7 @@ export interface Persister<
    * ```
    * @category Getter
    */
-  getStore(): PersistedStore<Schemas, StoreType>;
+  getStore(): PersistedStore<Schemas, Persist>;
 
   /**
    * The destroy method should be called when this Persister object is no longer
@@ -1226,10 +1245,8 @@ export interface Persister<
    * The PersisterStats object contains a count of the number of times the
    * Persister has loaded and saved data.
    *
-   * The statistics are only populated in a debug build: production builds
-   * return an empty object. The method is intended to be used during
-   * development to ensure your persistence layer is acting as expected, for
-   * example.
+   * The method is intended to be used during development to ensure your
+   * persistence layer is acting as expected, for example.
    * @returns A PersisterStats object containing Persister load and save
    * statistics.
    * @example
@@ -1276,21 +1293,21 @@ export interface Persister<
  * ```ts override
  * createCustomPersister<
  *   ListeningHandle,
- *   StoreType extends StoreTypes = 1,
+ *   Persist extends Persists = Persists.StoreOnly,
  * >(
- *   store: PersistedStore<StoreType>,
- *   getPersisted: () => Promise<PersistedContent<StoreType> | undefined>,
+ *   store: PersistedStore<Persist>,
+ *   getPersisted: () => Promise<PersistedContent<Persist> | undefined>,
  *   setPersisted: (
- *     getContent: () => PersistedContent<StoreType>,
- *     changes?: PersistedChanges<StoreType>,
+ *     getContent: () => PersistedContent<Persist>,
+ *     changes?: PersistedChanges<Persist>,
  *   ) => Promise<void>,
  *   addPersisterListener: (
- *     listener: PersisterListener<StoreType>,
+ *     listener: PersisterListener<Persist>,
  *   ) => ListeningHandle,
  *   delPersisterListener: (listeningHandle: ListeningHandle) => void,
  *   onIgnoredError?: (error: any) => void,
- *   supportedStoreType?: StoreType,
- * ): Persister<StoreType>;
+ *   persistable?: Persist,
+ * ): Persister<Persist>;
  * ```
  *
  * As well as providing a reference to the Store to persist, you must provide
@@ -1328,9 +1345,9 @@ export interface Persister<
  * @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.
- * @param supportedStoreType Since v5.0, an optional integer to indicate which
- * types of Store are supported by this Persister: `1` indicates only a regular
- * Store is supported, `2` indicates only a MergeableStore is supported, and `3`
+ * @param persistable Since v5.0, an optional integer to indicate which types of
+ * Store are supported by this Persister: `1` indicates only a regular Store is
+ * supported, `2` indicates only a MergeableStore is supported, and `3`
  * indicates that both Store and MergeableStore are supported.
  * @returns A reference to the new Persister object.
  * @example
@@ -1375,18 +1392,18 @@ export interface Persister<
 export function createCustomPersister<
   Schemas extends OptionalSchemas,
   ListeningHandle,
-  StoreType extends StoreTypes = 1,
+  Persist extends Persists = Persists.StoreOnly,
 >(
-  store: PersistedStore<Schemas, StoreType>,
-  getPersisted: () => Promise<PersistedContent<Schemas, StoreType> | undefined>,
+  store: PersistedStore<Schemas, Persist>,
+  getPersisted: () => Promise<PersistedContent<Schemas, Persist> | undefined>,
   setPersisted: (
-    getContent: () => PersistedContent<Schemas, StoreType>,
-    changes?: PersistedChanges<Schemas, StoreType>,
+    getContent: () => PersistedContent<Schemas, Persist>,
+    changes?: PersistedChanges<Schemas, Persist>,
   ) => Promise<void>,
   addPersisterListener: (
-    listener: PersisterListener<Schemas, StoreType>,
+    listener: PersisterListener<Schemas, Persist>,
   ) => ListeningHandle,
   delPersisterListener: (listeningHandle: ListeningHandle) => void,
   onIgnoredError?: (error: any) => void,
-  supportedStoreType?: StoreType,
-): Persister<Schemas, StoreType>;
+  persistable?: Persist,
+): Persister<Schemas, Persist>;

package/@types/queries/index.d.cts

@@ -335,7 +335,7 @@ export type ResultTableCellIdsListener = (
  * @param queries A reference to the Queries object that changed.
  * @param tableId The Id of the ResultTable that changed, which is also the
  * query Id.
- * @param count The number of ResultRow objects in the ResultTable
+ * @param count The number of ResultRow objects in the ResultTable.
  * @category Listener
  * @since v4.1.0
  */
@@ -545,8 +545,7 @@ export type ResultCellChange = [
  * The QueriesListenerStats type describes the number of listeners registered
  * with the Queries object, and can be used for debugging purposes.
  *
- * A QueriesListenerStats object is returned from the getListenerStats method,
- * and is only populated in a debug build.
+ * A QueriesListenerStats object is returned from the getListenerStats method.
  * @category Development
  * @since v2.0.0
  */
@@ -3020,8 +3019,8 @@ export interface Queries {
    * ResultCell Id being used to sort them, whether descending or not, and the
    * offset and limit of the number of Ids returned, for pagination purposes. It
    * also receives the sorted array of Ids itself, so that you can use them in
-   * the listener without the additional cost of an explicit call to
-   * getResultSortedRowIds
+   * the listener without the additional cost of an explicit call to the
+   * getResultSortedRowIds method.
    *
    * Such a listener is called when a ResultRow is added or removed, but also
    * when a value in the specified ResultCell (somewhere in the ResultTable) has
@@ -3573,10 +3572,8 @@ export interface Queries {
    * listeners registered with the Queries object, and is used for debugging
    * purposes.
    *
-   * The statistics are only populated in a debug build: production builds
-   * return an empty object. The method is intended to be used during
-   * development to ensure your application is not leaking listener
-   * registrations, for example.
+   * The method is intended to be used during development to ensure your
+   * application is not leaking listener registrations, for example.
    * @returns A QueriesListenerStats object containing Queries listener
    * statistics.
    * @example

package/@types/queries/index.d.ts

@@ -335,7 +335,7 @@ export type ResultTableCellIdsListener = (
  * @param queries A reference to the Queries object that changed.
  * @param tableId The Id of the ResultTable that changed, which is also the
  * query Id.
- * @param count The number of ResultRow objects in the ResultTable
+ * @param count The number of ResultRow objects in the ResultTable.
  * @category Listener
  * @since v4.1.0
  */
@@ -545,8 +545,7 @@ export type ResultCellChange = [
  * The QueriesListenerStats type describes the number of listeners registered
  * with the Queries object, and can be used for debugging purposes.
  *
- * A QueriesListenerStats object is returned from the getListenerStats method,
- * and is only populated in a debug build.
+ * A QueriesListenerStats object is returned from the getListenerStats method.
  * @category Development
  * @since v2.0.0
  */
@@ -3020,8 +3019,8 @@ export interface Queries {
    * ResultCell Id being used to sort them, whether descending or not, and the
    * offset and limit of the number of Ids returned, for pagination purposes. It
    * also receives the sorted array of Ids itself, so that you can use them in
-   * the listener without the additional cost of an explicit call to
-   * getResultSortedRowIds
+   * the listener without the additional cost of an explicit call to the
+   * getResultSortedRowIds method.
    *
    * Such a listener is called when a ResultRow is added or removed, but also
    * when a value in the specified ResultCell (somewhere in the ResultTable) has
@@ -3573,10 +3572,8 @@ export interface Queries {
    * listeners registered with the Queries object, and is used for debugging
    * purposes.
    *
-   * The statistics are only populated in a debug build: production builds
-   * return an empty object. The method is intended to be used during
-   * development to ensure your application is not leaking listener
-   * registrations, for example.
+   * The method is intended to be used during development to ensure your
+   * application is not leaking listener registrations, for example.
    * @returns A QueriesListenerStats object containing Queries listener
    * statistics.
    * @example

package/@types/queries/with-schemas/index.d.cts

@@ -384,7 +384,7 @@ export type ResultTableCellIdsListener<Schemas extends OptionalSchemas> = (
  * @param queries A reference to the Queries object that changed.
  * @param tableId The Id of the ResultTable that changed, which is also the
  * query Id.
- * @param count The number of ResultRow objects in the ResultTable
+ * @param count The number of ResultRow objects in the ResultTable.
  * @category Listener
  * @since v4.1.0
  */
@@ -654,8 +654,7 @@ export type ResultCellChange = [
  * The QueriesListenerStats type describes the number of listeners registered
  * with the Queries object, and can be used for debugging purposes.
  *
- * A QueriesListenerStats object is returned from the getListenerStats method,
- * and is only populated in a debug build.
+ * A QueriesListenerStats object is returned from the getListenerStats method.
  * @category Development
  * @since v2.0.0
  */
@@ -3297,8 +3296,8 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * ResultCell Id being used to sort them, whether descending or not, and the
    * offset and limit of the number of Ids returned, for pagination purposes. It
    * also receives the sorted array of Ids itself, so that you can use them in
-   * the listener without the additional cost of an explicit call to
-   * getResultSortedRowIds
+   * the listener without the additional cost of an explicit call to the
+   * getResultSortedRowIds method.
    *
    * Such a listener is called when a ResultRow is added or removed, but also
    * when a value in the specified ResultCell (somewhere in the ResultTable) has
@@ -3887,10 +3886,8 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * listeners registered with the Queries object, and is used for debugging
    * purposes.
    *
-   * The statistics are only populated in a debug build: production builds
-   * return an empty object. The method is intended to be used during
-   * development to ensure your application is not leaking listener
-   * registrations, for example.
+   * The method is intended to be used during development to ensure your
+   * application is not leaking listener registrations, for example.
    * @returns A QueriesListenerStats object containing Queries listener
    * statistics.
    * @example

package/@types/queries/with-schemas/index.d.ts

@@ -384,7 +384,7 @@ export type ResultTableCellIdsListener<Schemas extends OptionalSchemas> = (
  * @param queries A reference to the Queries object that changed.
  * @param tableId The Id of the ResultTable that changed, which is also the
  * query Id.
- * @param count The number of ResultRow objects in the ResultTable
+ * @param count The number of ResultRow objects in the ResultTable.
  * @category Listener
  * @since v4.1.0
  */
@@ -654,8 +654,7 @@ export type ResultCellChange = [
  * The QueriesListenerStats type describes the number of listeners registered
  * with the Queries object, and can be used for debugging purposes.
  *
- * A QueriesListenerStats object is returned from the getListenerStats method,
- * and is only populated in a debug build.
+ * A QueriesListenerStats object is returned from the getListenerStats method.
  * @category Development
  * @since v2.0.0
  */
@@ -3297,8 +3296,8 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * ResultCell Id being used to sort them, whether descending or not, and the
    * offset and limit of the number of Ids returned, for pagination purposes. It
    * also receives the sorted array of Ids itself, so that you can use them in
-   * the listener without the additional cost of an explicit call to
-   * getResultSortedRowIds
+   * the listener without the additional cost of an explicit call to the
+   * getResultSortedRowIds method.
    *
    * Such a listener is called when a ResultRow is added or removed, but also
    * when a value in the specified ResultCell (somewhere in the ResultTable) has
@@ -3887,10 +3886,8 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * listeners registered with the Queries object, and is used for debugging
    * purposes.
    *
-   * The statistics are only populated in a debug build: production builds
-   * return an empty object. The method is intended to be used during
-   * development to ensure your application is not leaking listener
-   * registrations, for example.
+   * The method is intended to be used during development to ensure your
+   * application is not leaking listener registrations, for example.
    * @returns A QueriesListenerStats object containing Queries listener
    * statistics.
    * @example

package/@types/relationships/index.d.cts

@@ -139,7 +139,7 @@ export type LinkedRowIdsListener = (
  * purposes.
  *
  * A RelationshipsListenerStats object is returned from the getListenerStats
- * method, and is only populated in a debug build.
+ * method.
  * @category Development
  */
 export type RelationshipsListenerStats = {
@@ -1198,10 +1198,8 @@ export interface Relationships {
    * The RelationshipsListenerStats object contains a breakdown of the different
    * types of listener.
    *
-   * The statistics are only populated in a debug build: production builds
-   * return an empty object. The method is intended to be used during
-   * development to ensure your application is not leaking listener
-   * registrations, for example.
+   * The method is intended to be used during development to ensure your
+   * application is not leaking listener registrations, for example.
    * @returns A RelationshipsListenerStats object containing Relationships
    * listener statistics.
    * @example

package/@types/relationships/index.d.ts

@@ -139,7 +139,7 @@ export type LinkedRowIdsListener = (
  * purposes.
  *
  * A RelationshipsListenerStats object is returned from the getListenerStats
- * method, and is only populated in a debug build.
+ * method.
  * @category Development
  */
 export type RelationshipsListenerStats = {
@@ -1198,10 +1198,8 @@ export interface Relationships {
    * The RelationshipsListenerStats object contains a breakdown of the different
    * types of listener.
    *
-   * The statistics are only populated in a debug build: production builds
-   * return an empty object. The method is intended to be used during
-   * development to ensure your application is not leaking listener
-   * registrations, for example.
+   * The method is intended to be used during development to ensure your
+   * application is not leaking listener registrations, for example.
    * @returns A RelationshipsListenerStats object containing Relationships
    * listener statistics.
    * @example

package/@types/relationships/with-schemas/index.d.cts

@@ -196,7 +196,7 @@ export type LinkedRowIdsListener<Schemas extends OptionalSchemas> = (
  * purposes.
  *
  * A RelationshipsListenerStats object is returned from the getListenerStats
- * method, and is only populated in a debug build.
+ * method.
  * @category Development
  */
 export type RelationshipsListenerStats = {
@@ -1345,10 +1345,8 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * The RelationshipsListenerStats object contains a breakdown of the different
    * types of listener.
    *
-   * The statistics are only populated in a debug build: production builds
-   * return an empty object. The method is intended to be used during
-   * development to ensure your application is not leaking listener
-   * registrations, for example.
+   * The method is intended to be used during development to ensure your
+   * application is not leaking listener registrations, for example.
    * @returns A RelationshipsListenerStats object containing Relationships
    * listener statistics.
    * @example

package/@types/relationships/with-schemas/index.d.ts

@@ -196,7 +196,7 @@ export type LinkedRowIdsListener<Schemas extends OptionalSchemas> = (
  * purposes.
  *
  * A RelationshipsListenerStats object is returned from the getListenerStats
- * method, and is only populated in a debug build.
+ * method.
  * @category Development
  */
 export type RelationshipsListenerStats = {
@@ -1345,10 +1345,8 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * The RelationshipsListenerStats object contains a breakdown of the different
    * types of listener.
    *
-   * The statistics are only populated in a debug build: production builds
-   * return an empty object. The method is intended to be used during
-   * development to ensure your application is not leaking listener
-   * registrations, for example.
+   * The method is intended to be used during development to ensure your
+   * application is not leaking listener registrations, for example.
    * @returns A RelationshipsListenerStats object containing Relationships
    * listener statistics.
    * @example

package/@types/store/index.d.cts

@@ -746,7 +746,7 @@ export type HasTableCellListener<Store extends StoreAlias = StoreAlias> = (
  * the Table whose Row Ids changed, and the number of Row objects in the Table.
  * @param store A reference to the Store that changed.
  * @param tableId The Id of the Table that changed.
- * @param count The number of Row objects in the Table
+ * @param count The number of Row objects in the Table.
  * @category Listener
  * @since v4.1.0
  */
@@ -1451,8 +1451,7 @@ export type TransactionLog = [
  *
  * The StoreListenerStats object contains a breakdown of the different types of
  * listener. Totals include both mutator and non-mutator listeners. A
- * StoreListenerStats object is returned from the getListenerStats method, and
- * is only populated in a debug build.
+ * StoreListenerStats object is returned from the getListenerStats method.
  * @category Development
  */
 export type StoreListenerStats = {
@@ -1490,7 +1489,7 @@ export type StoreListenerStats = {
   hasTableCell: number;
   /**
    * The number of RowCountListener functions registered with the Store, since
-   * v4.1.0
+   * v4.1.0.
    */
   rowCount: number;
   /**
@@ -1579,7 +1578,7 @@ export type StoreListenerStats = {
  *
  * The keyed value support is best thought of as a flat JavaScript object. The
  * Store contains a number of Value objects, each with a unique ID, and which is
- * a string, boolean, or number:
+ * a string, boolean, or number.
  *
  * ```json
  * {                  // Store
@@ -1663,8 +1662,8 @@ export type StoreListenerStats = {
  * There are two extra methods to manipulate Row objects. The addRow method is
  * like the setRow method but automatically assigns it a new unique Id. And the
  * setPartialRow method lets you update multiple Cell values in a Row without
- * affecting the others. (There is a similar setPartialValues method to do the
- * same for the Values in a Store.)
+ * affecting the others. There is a similar setPartialValues method to do the
+ * same for the Values in a Store.
  *
  * You can listen to attempts to write invalid data to a Value or Cell with the
  * addInvalidValueListener method or addInvalidCellListener method.
@@ -2769,6 +2768,7 @@ export interface Store {
    * can be chained in a fluent style.
    * @param content An array containing the tabular and keyed-value data of the
    * Store to be set.
+   * @returns A reference to the Store.
    * @example
    * This example sets the data of a Store.
    *
@@ -2829,6 +2829,7 @@ export interface Store {
    * The method returns a reference to the Store so that subsequent operations
    * can be chained in a fluent style.
    * @param tables The data of the Store to be set.
+   * @returns A reference to the Store.
    * @example
    * This example sets the tabular data of a Store.
    *
@@ -2883,6 +2884,7 @@ export interface Store {
    * can be chained in a fluent style.
    * @param tableId The Id of the Table in the Store.
    * @param table The data of a single Table to be set.
+   * @returns A reference to the Store.
    * @example
    * This example sets the data of a single Table.
    *
@@ -2983,7 +2985,7 @@ export interface Store {
    *
    * Assuming that at least some of the provided Row object is valid, a new Row
    * will be created. If the object is completely invalid, no change will be
-   * made to the Store and the method will return `undefined`
+   * made to the Store and the method will return `undefined`.
    *
    * You should not guarantee the form of the unique Id that is generated when a
    * Row is added to the Table. However it is likely to be a string
@@ -3336,8 +3338,7 @@ export interface Store {
    * @param changes The Changes to apply to the Store.
    * @returns A reference to the Store.
    * @example
-   * This example applies a Changes object that sets a Cell and
-   * removes a Value.
+   * This example applies a Changes object that sets a Cell and removes a Value.
    *
    * ```js
    * import {createStore} from 'tinybase';
@@ -4125,6 +4126,7 @@ export interface Store {
    * This is useful for deciding whether to rollback a transaction, for example.
    * The returned object is only meaningful if the method is called when the
    * Store is in a transaction - such as in a TransactionListener.
+   * @returns A Changes object representing the changes.
    * @example
    * This example makes changes to the Store. At the end of the transaction,
    * detail about what changed is enumerated.
@@ -4161,6 +4163,7 @@ export interface Store {
    * This is useful for deciding whether to rollback a transaction, for example.
    * The returned object is only meaningful if the method is called when the
    * Store is in a transaction - such as in a TransactionListener.
+   * @returns A TransactionLog object representing the changes.
    * @example
    * This example makes changes to the Store. At the end of the transaction,
    * detail about what changed is enumerated.
@@ -6571,11 +6574,11 @@ export interface Store {
    * Special note should be made for how the listener will be called when a
    * TablesSchema is present. The listener will be called:
    *
-   * - if a Table is being updated that is not specified in the TablesSchema
-   * - if a Cell is of the wrong type specified in the TablesSchema
-   * - if a Cell is omitted and is not defaulted in the TablesSchema
-   * - if an empty Row is provided and there are no Cell defaults in the
-   *   TablesSchema
+   * - if a Table is being updated that is not specified in the TablesSchema,
+   * - if a Cell is of the wrong type specified in the TablesSchema,
+   * - if a Cell is omitted and is not defaulted in the TablesSchema,
+   * - or if an empty Row is provided and there are no Cell defaults in the
+   *   TablesSchema.
    *
    * The listener will not be called if a Cell that is defaulted in the
    * TablesSchema is not provided, as long as all of the Cells that are _not_
@@ -6803,10 +6806,10 @@ export interface Store {
    * Special note should be made for how the listener will be called when a
    * ValuesSchema is present. The listener will be called:
    *
-   * - if a Value is being updated that is not specified in the ValuesSchema
-   * - if a Value is of the wrong type specified in the ValuesSchema
-   * - if a Value is omitted when using setValues that is not defaulted in the
-   *   ValuesSchema
+   * - if a Value is being updated that is not specified in the ValuesSchema,
+   * - if a Value is of the wrong type specified in the ValuesSchema,
+   * - or if a Value is omitted when using setValues that is not defaulted in
+   *   the ValuesSchema.
    *
    * The listener will not be called if a Value that is defaulted in the
    * ValuesSchema is not provided, as long as all of the Values that are _not_
@@ -7367,10 +7370,8 @@ export interface Store {
    * The StoreListenerStats object contains a breakdown of the different types
    * of listener. Totals include both mutator and non-mutator listeners.
    *
-   * The statistics are only populated in a debug build: production builds
-   * return an empty object. The method is intended to be used during
-   * development to ensure your application is not leaking listener
-   * registrations, for example.
+   * The method is intended to be used during development to ensure your
+   * application is not leaking listener registrations, for example.
    * @returns A StoreListenerStats object containing Store listener statistics.
    * @example
    * This example gets the listener statistics of a small and simple Store.