tinybase 5.0.0-beta.25 → 5.0.0-beta.27

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
  */
@@ -2160,7 +2159,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * @param queryId The Id of a query.
    * @returns An object containing the entire data of the ResultTable of the
    * query.
-   * @returns The result of the query, structured as a ResultTable.
    * @example
    * This example creates a Queries object, a single query definition, and then
    * calls this method on it (as well as a non-existent definition) to get the
@@ -3297,8 +3295,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 +3885,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
  */
@@ -2160,7 +2159,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * @param queryId The Id of a query.
    * @returns An object containing the entire data of the ResultTable of the
    * query.
-   * @returns The result of the query, structured as a ResultTable.
    * @example
    * This example creates a Queries object, a single query definition, and then
    * calls this method on it (as well as a non-existent definition) to get the
@@ -3297,8 +3295,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 +3885,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.

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

@@ -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.

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

@@ -1224,7 +1224,7 @@ export type HasTableCellListener<
  * 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
  */
@@ -2419,8 +2419,7 @@ export type TransactionLog<Schemas extends OptionalSchemas> = {
  *
  * 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 = {
@@ -2458,7 +2457,7 @@ export type StoreListenerStats = {
   hasTableCell: number;
   /**
    * The number of RowCountListener functions registered with the Store, since
-   * v4.1.0
+   * v4.1.0.
    */
   rowCount: number;
   /**
@@ -2547,7 +2546,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
@@ -2631,8 +2630,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.
@@ -3888,6 +3887,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * 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.
    *
@@ -3954,6 +3954,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * 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.
    *
@@ -4014,6 +4015,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * 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.
    *
@@ -4133,7 +4135,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    *
    * 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
@@ -4543,8 +4545,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * @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';
@@ -5430,6 +5431,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * 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.
@@ -5472,6 +5474,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * 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.
@@ -8212,11 +8215,11 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * 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_
@@ -8454,10 +8457,10 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * 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_
@@ -9040,10 +9043,8 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * 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.