tinybase 4.0.0-beta.4 → 4.0.0-beta.5.1

package/lib/types/with-schemas/queries.d.ts

@@ -6,10 +6,9 @@
  * function, which returns a new Queries object. That object in turn has methods
  * that let you create new query definitions, access their results directly, and
  * register listeners for when those results change.
- *
  * @packageDocumentation
  * @module queries
- * @since v2.0
+ * @since v2.0.0
  */
 
 import {
@@ -33,7 +32,6 @@ import {Id, IdOrNull, Ids} from './common.d';
  * addResultTableListener method. It is similar to the Table type in the store
  * module, but without schema-specific typing, and is a regular JavaScript
  * object containing individual ResultRow objects, keyed by their Id.
- *
  * @example
  * ```js
  * const resultTable: ResultTable = {
@@ -53,7 +51,6 @@ export type ResultTable = {[rowId: Id]: ResultRow};
  * addResultRowListener method. It is similar to the Row type in the store
  * module, but without schema-specific typing, and is a regular JavaScript
  * object containing individual ResultCell objects, keyed by their Id.
- *
  * @example
  * ```js
  * const resultRow: ResultRow = {species: 'dog', color: 'brown'};
@@ -70,7 +67,6 @@ export type ResultRow = {[cellId: Id]: ResultCell};
  * addResultCellListener method. It is similar to the Cell type in the store
  * module, but without schema-specific typing, and is a JavaScript string,
  * number, or boolean.
- *
  * @example
  * ```js
  * const resultCell: ResultCell = 'dog';
@@ -82,7 +78,6 @@ export type ResultCell = string | number | boolean;
 /**
  * The ResultCellOrUndefined type is the data structure representing a single
  * cell in the results of a query, or the value `undefined`.
- *
  * @category Result
  */
 export type ResultCellOrUndefined = ResultCell | undefined;
@@ -94,12 +89,11 @@ export type ResultCellOrUndefined = ResultCell | undefined;
  * There are a number of common predefined aggregators, such as for counting,
  * summing, and averaging values. This type is instead used for when you wish to
  * use a more complex aggregation of your own devising.
- *
  * @param cells The array of Cell values to be aggregated.
  * @param length The length of the array of Cell values to be aggregated.
  * @returns The value of the aggregation.
  * @category Aggregators
- * @since v2.0
+ * @since v2.0.0
  */
 export type Aggregate = (cells: ResultCell[], length: number) => ResultCell;
 
@@ -119,13 +113,12 @@ export type Aggregate = (cells: ResultCell[], length: number) => ResultCell;
  * Where possible, if you are providing a custom Aggregate, seek an
  * implementation of an AggregateAdd function that can reduce the complexity
  * cost of growing the input data set.
- *
  * @param current The current value of the aggregation.
  * @param add The Cell value being added to the aggregation.
  * @param length The length of the array of Cell values in the aggregation.
  * @returns The new value of the aggregation.
  * @category Aggregators
- * @since v2.0
+ * @since v2.0.0
  */
 export type AggregateAdd = (
   current: ResultCell,
@@ -152,13 +145,12 @@ export type AggregateAdd = (
  * Where possible, if you are providing a custom Aggregate, seek an
  * implementation of an AggregateRemove function that can reduce the complexity
  * cost of shrinking the input data set.
- *
  * @param current The current value of the aggregation.
  * @param remove The Cell value being removed from the aggregation.
  * @param length The length of the array of Cell values in the aggregation.
  * @returns The new value of the aggregation.
  * @category Aggregators
- * @since v2.0
+ * @since v2.0.0
  */
 export type AggregateRemove = (
   current: ResultCell,
@@ -183,14 +175,13 @@ export type AggregateRemove = (
  * Where possible, if you are providing a custom Aggregate, seek an
  * implementation of an AggregateReplace function that can reduce the complexity
  * cost of changing the input data set in place.
- *
  * @param current The current value of the aggregation.
  * @param add The Cell value being added to the aggregation.
  * @param remove The Cell value being removed from the aggregation.
  * @param length The length of the array of Cell values in the aggregation.
  * @returns The new value of the aggregation.
  * @category Aggregators
- * @since v2.0
+ * @since v2.0.0
  */
 export type AggregateReplace = (
   current: ResultCell,
@@ -205,10 +196,9 @@ export type AggregateReplace = (
  * A QueryCallback is provided when using the forEachQuery method, so that you
  * can do something based on every query in the Queries object. See that method
  * for specific examples.
- *
  * @param queryId The Id of the query that the callback can operate on.
  * @category Callback
- * @since v2.0
+ * @since v2.0.0
  */
 export type QueryCallback = (queryId: Id) => void;
 
@@ -219,7 +209,6 @@ export type QueryCallback = (queryId: Id) => void;
  * A ResultTableCallback is provided when using the forEachResultTable method,
  * so that you can do something based on every ResultTable in the Queries
  * object. See that method for specific examples.
- *
  * @param tableId The Id of the ResultTable that the callback can operate on.
  * @param forEachRow A function that will let you iterate over the ResultRow
  * objects in this ResultTable.
@@ -237,7 +226,6 @@ export type ResultTableCallback = (
  * A ResultRowCallback is provided when using the forEachResultRow method, so
  * that you can do something based on every ResultRow in a ResultTable. See that
  * method for specific examples.
- *
  * @param rowId The Id of the ResultRow that the callback can operate on.
  * @param forEachRow A function that will let you iterate over the ResultCell
  * values in this ResultRow.
@@ -255,7 +243,6 @@ export type ResultRowCallback = (
  * A ResultCellCallback is provided when using the forEachResultCell method, so
  * that you can do something based on every ResultCell in a ResultRow. See that
  * method for specific examples.
- *
  * @param cellId The Id of the ResultCell that the callback can operate on.
  * @param cell The value of the ResultCell.
  * @category Callback
@@ -283,14 +270,13 @@ export type ResultCellCallback = (cellId: Id, cell: ResultCell) => void;
  * object, the Id of the ResultTable that changed (which is the same as the
  * query Id), and a GetCellResultChange function that can be used to query
  * ResultCell values before and after the change.
- *
  * @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 getCellChange A function that returns information about any
  * ResultCell's changes.
  * @category Listener
- * @since v2.0
+ * @since v2.0.0
  */
 export type ResultTableListener<Schemas extends OptionalSchemas> = (
   queries: Queries<Schemas>,
@@ -314,12 +300,11 @@ export type ResultTableListener<Schemas extends OptionalSchemas> = (
  * When called, a ResultRowIdsListener is given a reference to the Queries
  * object, and the Id of the ResultTable whose ResultRow Ids changed (which is
  * the same as the query Id).
- *
  * @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.
  * @category Listener
- * @since v2.0
+ * @since v2.0.0
  */
 export type ResultRowIdsListener<Schemas extends OptionalSchemas> = (
   queries: Queries<Schemas>,
@@ -354,7 +339,6 @@ export type ResultRowIdsListener<Schemas extends OptionalSchemas> = (
  * 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.
- *
  * @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.
@@ -365,7 +349,7 @@ export type ResultRowIdsListener<Schemas extends OptionalSchemas> = (
  * @param limit The maximum number of ResultRow Ids returned.
  * @param sortedRowIds The sorted ResultRow Ids themselves.
  * @category Listener
- * @since v2.0
+ * @since v2.0.0
  */
 export type ResultSortedRowIdsListener<Schemas extends OptionalSchemas> = (
   queries: Queries<Schemas>,
@@ -399,7 +383,6 @@ export type ResultSortedRowIdsListener<Schemas extends OptionalSchemas> = (
  * the Id of the ResultTable that changed (which is the same as the query Id),
  * the Id of the ResultRow that changed, and a GetCellResultChange function that
  * can be used to query ResultCell values before and after the change.
- *
  * @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.
@@ -407,7 +390,7 @@ export type ResultSortedRowIdsListener<Schemas extends OptionalSchemas> = (
  * @param getCellChange A function that returns information about any
  * ResultCell's changes.
  * @category Listener
- * @since v2.0
+ * @since v2.0.0
  */
 export type ResultRowListener<Schemas extends OptionalSchemas> = (
   queries: Queries<Schemas>,
@@ -436,13 +419,12 @@ export type ResultRowListener<Schemas extends OptionalSchemas> = (
  * When called, a ResultCellIdsListener is given a reference to the Queries
  * object, the Id of the ResultTable that changed (which is the same as the
  * query Id), and the Id of the ResultRow whose ResultCell Ids changed.
- *
  * @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 rowId The Id of the ResultRow that changed.
  * @category Listener
- * @since v2.0
+ * @since v2.0.0
  */
 export type ResultCellIdsListener<Schemas extends OptionalSchemas> = (
   queries: Queries<Schemas>,
@@ -477,7 +459,6 @@ export type ResultCellIdsListener<Schemas extends OptionalSchemas> = (
  * It is also given the new value of the ResultCell, the old value of the
  * ResultCell, and a GetCellResultChange function that can be used to query
  * ResultCell values before and after the change.
- *
  * @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.
@@ -488,7 +469,7 @@ export type ResultCellIdsListener<Schemas extends OptionalSchemas> = (
  * @param getCellChange A function that returns information about any
  * ResultCell's changes.
  * @category Listener
- * @since v2.0
+ * @since v2.0.0
  */
 export type ResultCellListener<Schemas extends OptionalSchemas> = (
   queries: Queries<Schemas>,
@@ -508,7 +489,6 @@ export type ResultCellListener<Schemas extends OptionalSchemas> = (
  * the Store changing. The listener can then fetch the previous value of a
  * ResultCell before the current transaction, the new value after it, and a
  * convenience flag that indicates that the value has changed.
- *
  * @param tableId The Id of the ResultTable to inspect.
  * @param rowId The Id of the ResultRow to inspect.
  * @param cellId The Id of the ResultCell to inspect.
@@ -530,7 +510,6 @@ export type GetCellResultChange = (
  * every listener when called. This array contains the previous value of a
  * ResultCell before the current transaction, the new value after it, and a
  * convenience flag that indicates that the value has changed.
- *
  * @category Listener
  */
 export type ResultCellChange = [
@@ -545,9 +524,8 @@ export type ResultCellChange = [
  *
  * A QueriesListenerStats object is returned from the getListenerStats method,
  * and is only populated in a debug build.
- *
  * @category Development
- * @since v2.0
+ * @since v2.0.0
  */
 export type QueriesListenerStats = {
   /**
@@ -579,9 +557,8 @@ export type QueriesListenerStats = {
  * A GetTableCell can be provided when setting query definitions, specifically
  * in the Select and Where clauses when you want to create or filter on
  * calculated values. See those methods for specific examples.
- *
  * @category Callback
- * @since v2.0
+ * @since v2.0.0
  */
 export type GetTableCell<
   Schema extends OptionalTablesSchema,
@@ -591,13 +568,6 @@ export type GetTableCell<
    * When called with one parameter, this function will return the value of
    * the specified Cell from the query's root Table for the Row being selected
    * or filtered.
-   *
-   * This has schema-based typing. The following is a simplified representation:
-   *
-   * ```ts override
-   * (cellId: Id): CellOrUndefined;
-   * ```
-   *
    * @param cellId The Id of the Cell to fetch the value for.
    * @returns A Cell value or `undefined`.
    */
@@ -608,14 +578,6 @@ export type GetTableCell<
    * When called with two parameters, this function will return the value of
    * the specified Cell from a Table that has been joined in the query, for
    * the Row being selected or filtered.
-   *
-   * This has schema-based typing. The following is a simplified representation:
-   *
-   * ```ts override
-   * (joinedTableId: Id, joinedCellId: Id): CellOrUndefined;
-};
-   * ```
-   *
    * @param joinedTableId The Id of the Table to fetch the value from. If the
    * underlying Table was joined 'as' a different Id, that should instead be
    * used.
@@ -645,7 +607,6 @@ export type GetTableCell<
  * The Select function is provided to the third `query` parameter of the
  * setQueryDefinition method. A query definition must call the Select function
  * at least once, otherwise it will be meaningless and return no data.
- *
  * @example
  * This example shows a query that selects two Cells from the main query Table.
  *
@@ -733,7 +694,7 @@ export type GetTableCell<
  * // -> {cujo: {description: 'dog for Carol'}}
  * ```
  * @category Definition
- * @since v2.0
+ * @since v2.0.0
  */
 export type Select<
   Schema extends OptionalTablesSchema,
@@ -742,13 +703,6 @@ export type Select<
   /**
    * Calling this function with one Id parameter will indicate that the query
    * should select the value of the specified Cell from the query's root Table.
-   *
-   * This has schema-based typing. The following is a simplified representation:
-   *
-   * ```ts override
-   * (cellId: Id): SelectedAs;
-   * ```
-   *
    * @param cellId The Id of the Cell to fetch the value for.
    * @returns A SelectedAs object so that the selected Cell Id can be optionally
    * aliased.
@@ -760,13 +714,6 @@ export type Select<
    * Calling this function with two parameters will indicate that the query
    * should select the value of the specified Cell from a Table that has been
    * joined in the query.
-   *
-   * This has schema-based typing. The following is a simplified representation:
-   *
-   * ```ts override
-   * (joinedTableId: Id, joinedCellId: Id): SelectedAs;
-   * ```
-   *
    * @param joinedTableId The Id of the Table to fetch the value from. If the
    * underlying Table was joined 'as' a different Id, that should instead be
    * used.
@@ -782,16 +729,6 @@ export type Select<
    * Calling this function with one callback parameter will indicate that the
    * query should select a calculated value, based on one or more Cell values in
    * the root Table or a joined Table, or on the root Table's Row Id.
-   *
-   * This has schema-based typing. The following is a simplified representation:
-   *
-   * ```ts override
-   * (
-   *   getCell: (getTableCell: GetTableCell, rowId: Id) => ResultCellOrUndefined,
-   * ): SelectedAs;
-};
-   * ```
-   *
    * @param getCell A callback that takes a GetTableCell function and the main
    * Table's Row Id. These can be used to programmatically create a calculated
    * value from multiple Cell values and the Row Id.
@@ -817,7 +754,6 @@ export type Select<
  * Note that if two Select clauses are both aliased to the same name (or if two
  * columns with the same underlying name are selected, both _without_ aliases),
  * only the latter of two will be used in the query.
- *
  * @example
  * This example shows a query that selects two Cells, one from a joined Table.
  * Both are aliased with the 'as' function:
@@ -851,7 +787,7 @@ export type Select<
  * // -> {cujo: {petSpecies: 'dog', ownerName: 'Carol'}}
  * ```
  * @category Definition
- * @since v2.0
+ * @since v2.0.0
  */
 export type SelectedAs = {
   /**
@@ -881,7 +817,6 @@ export type SelectedAs = {
  * unfiltered query will only ever return the same number of Rows as the main
  * Table being queried, and indeed the resulting table (assuming it has not been
  * aggregated) will even preserve the root Table's original Row Ids.
- *
  * @example
  * This example shows a query that joins a single Table by using an Id present
  * in the main query Table.
@@ -1024,7 +959,7 @@ export type SelectedAs = {
  * // -> {cujo: {description: 'dog in Washington'}}
  * ```
  * @category Definition
- * @since v2.0
+ * @since v2.0.0
  */
 export type Join<
   Schema extends OptionalTablesSchema,
@@ -1034,13 +969,6 @@ export type Join<
    * Calling this function with two Id parameters will indicate that the join to
    * a Row in an adjacent Table is made by finding its Id in a Cell of the
    * query's root Table.
-   *
-   * This has schema-based typing. The following is a simplified representation:
-   *
-   * ```ts override
-   * (joinedTableId: Id, on: Id): JoinedAs;
-   * ```
-   *
    * @param joinedTableId The Id of the Table to join to.
    * @param on The Id of the Cell in the root Table that contains the joined
    * Table's Row Id.
@@ -1055,16 +983,6 @@ export type Join<
    * Calling this function with two parameters (where the second is a function)
    * will indicate that the join to a Row in an adjacent Table is made by
    * calculating its Id from the Cells and the Row Id of the query's root Table.
-   *
-   * This has schema-based typing. The following is a simplified representation:
-   *
-   * ```ts override
-   * (
-   *   joinedTableId: Id,
-   *   on: (getCell: GetCell, rowId: Id) => Id | undefined,
-   * ): JoinedAs;
-   * ```
-   *
    * @param joinedTableId The Id of the Table to join to.
    * @param on A callback that takes a GetCell function and the root Table's Row
    * Id. These can be used to programmatically calculate the joined Table's Row
@@ -1080,13 +998,6 @@ export type Join<
    * Calling this function with three Id parameters will indicate that the join
    * to a Row in distant Table is made by finding its Id in a Cell of an
    * intermediately joined Table.
-   *
-   * This has schema-based typing. The following is a simplified representation:
-   *
-   * ```ts override
-   * (joinedTableId: Id, fromIntermediateJoinedTableId: Id, on: Id): JoinedAs;
-   * ```
-   *
    * @param joinedTableId The Id of the distant Table to join to.
    * @param fromIntermediateJoinedTableId The Id of an intermediate Table (which
    * should have been in turn joined to the main query table via other Join
@@ -1114,21 +1025,6 @@ export type Join<
    * will indicate that the join to a Row in distant Table is made by
    * calculating its Id from the Cells and the Row Id of an intermediately
    * joined Table.
-   *
-   * This has schema-based typing. The following is a simplified representation:
-   *
-   * ```ts override
-   * (
-   *   joinedTableId: Id,
-   *   fromIntermediateJoinedTableId: Id,
-   *   on: (
-   *     getIntermediateJoinedCell: GetCell,
-   *     intermediateJoinedRowId: Id,
-   *   ) => Id | undefined,
-   * ): JoinedAs;
-};
-   * ```
-   *
    * @param joinedTableId The Id of the Table to join to.
    * @param fromIntermediateJoinedTableId The Id of an intermediate Table (which
    * should have been in turn joined to the main query table via other Join
@@ -1167,7 +1063,6 @@ export type Join<
  *
  * For the purposes of clarity, it's recommended to use an alias that does not
  * collide with a real underlying Table (whether included in the query or not).
- *
  * @example
  * This example shows a query that joins the same underlying Table twice, for
  * different purposes. Both joins are aliased with the 'as' function to
@@ -1203,7 +1098,7 @@ export type Join<
  * // -> {cujo: {buyer: 'Carol', seller: 'Alice'}}
  * ```
  * @category Definition
- * @since v2.0
+ * @since v2.0.0
  */
 export type JoinedAs = {
   /**
@@ -1231,7 +1126,6 @@ export type JoinedAs = {
  * describes conditions that should be met by underlying Cell values (whether
  * selected or not), and the latter describes conditions based on calculated and
  * aggregated values - after Group clauses have been applied.
- *
  * @example
  * This example shows a query that filters the results from a single Table by
  * comparing an underlying Cell from it with a value.
@@ -1326,7 +1220,7 @@ export type JoinedAs = {
  * // -> {cujo: {species: 'dog', state: 'WA'}}
  * ```
  * @category Definition
- * @since v2.0
+ * @since v2.0.0
  */
 export type Where<
   Schema extends OptionalTablesSchema,
@@ -1336,13 +1230,6 @@ export type Where<
    * Calling this function with two parameters is used to include only those
    * Rows for which a specified Cell in the query's root Table has a specified
    * value.
-   *
-   * This has schema-based typing. The following is a simplified representation:
-   *
-   * ```ts override
-   * (cellId: Id, equals: Cell): void;
-   * ```
-   *
    * @param cellId The Id of the Cell in the query's root Table to test.
    * @param equals The value that the Cell has to have for the Row to be
    * included in the result.
@@ -1354,13 +1241,6 @@ export type Where<
   /**
    * Calling this function with three parameters is used to include only those
    * Rows for which a specified Cell in a joined Table has a specified value.
-   *
-   * This has schema-based typing. The following is a simplified representation:
-   *
-   * ```ts override
-   * (joinedTableId: Id, joinedCellId: Id, equals: Cell): void;
-   * ```
-   *
    * @param joinedTableId The Id of the joined Table to test a value in. If the
    * underlying Table was joined 'as' a different Id, that should instead be
    * used.
@@ -1388,14 +1268,6 @@ export type Where<
    * Calling this function with one callback parameter is used to include only
    * those Rows which meet a calculated boolean condition, based on values in
    * the main and (optionally) joined Tables.
-   *
-   * This has schema-based typing. The following is a simplified representation:
-   *
-   * ```ts override
-   * (condition: (getTableCell: GetTableCell) => boolean): void;
-};
-   * ```
-   *
    * @param condition A callback that takes a GetTableCell function and that
    * should return `true` for the Row to be included in the result.
    */
@@ -1434,7 +1306,6 @@ export type Where<
  * function's algorithmic complexity by providing shortcuts that can nudge an
  * aggregation result when a single value is added, removed, or replaced in the
  * input values.
- *
  * @param selectedCellId The Id of the Cell to aggregate. If the underlying Cell
  * was selected 'as' a different Id, that should instead be used.
  * @param aggregate Either a string representing one of a set of common
@@ -1574,7 +1445,7 @@ export type Where<
  * // Both have a parrot at 3. Alice's worm at 1 is excluded from aggregation.
  * ```
  * @category Definition
- * @since v2.0
+ * @since v2.0.0
  */
 export type Group = (
   selectedCellId: Id,
@@ -1591,7 +1462,6 @@ export type Group = (
  * Note that if two Group clauses are both aliased to the same name (or if you
  * create two groups of the same underlying Cell, both _without_ aliases), only
  * the latter of two will be used in the query.
- *
  * @example
  * This example shows a query that groups the same underlying Cell twice, for
  * different purposes. Both groups are aliased with the 'as' function to
@@ -1620,7 +1490,7 @@ export type Group = (
  * // -> {1: {species: 'cat', minPrice: 3, maxPrice: 4}}
  * ```
  * @category Definition
- * @since v2.0
+ * @since v2.0.0
  */
 export type GroupedAs = {
   /**
@@ -1650,7 +1520,6 @@ export type GroupedAs = {
  * have not been grouped with a Group clause, you should expect it to be less
  * performant than using a Where clause, due to that being applied earlier in
  * the query process.
- *
  * @example
  * This example shows a query that filters the results from a grouped Table by
  * comparing a Cell from it with a value.
@@ -1715,14 +1584,13 @@ export type GroupedAs = {
  * // Parrots are filtered out because they have zero range in price.
  * ```
  * @category Definition
- * @since v2.0
+ * @since v2.0.0
  */
 export type Having = {
   /**
    * Calling this function with two parameters is used to include only those
    * Rows for which a specified Cell in the query's root Table has a specified
    * value.
-   *
    * @param selectedOrGroupedCellId The Id of the Cell in the query to test.
    * @param equals The value that the Cell has to have for the Row to be
    * included in the result.
@@ -1731,7 +1599,6 @@ export type Having = {
   /**
    * Calling this function with one callback parameter is used to include only
    * those Rows which meet a calculated boolean condition.
-   *
    * @param condition A callback that takes a GetCell function and that should
    * return `true` for the Row to be included in the result.
    */
@@ -1757,7 +1624,6 @@ export type Having = {
  * getResultCell method, and so on), and add listeners for when they change
  * (with the addResultTableListener method, the addResultRowListener method, the
  * addResultCellListener method, and so on).
- *
  * @example
  * This example shows a very simple lifecycle of a Queries object: from
  * creation, to adding definitions, getting their contents, and then registering
@@ -1833,7 +1699,7 @@ export type Having = {
  * @see Car Analysis demo
  * @see Movie Database demo
  * @category Queries
- * @since v2.0
+ * @since v2.0.0
  */
 export interface Queries<in out Schemas extends OptionalSchemas> {
   /**
@@ -1885,7 +1751,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    *
    * Additionally, you can use the getResultSortedRowIds method and
    * addResultSortedRowIdsListener method to sort and paginate the results.
-   *
    * @param queryId The Id of the query to define.
    * @param tableId The Id of the root Table the query will be based on.
    * @param query A callback which can take a `keywords` object and which uses
@@ -1913,7 +1778,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> {fido: {color: 'brown'}, cujo: {color: 'black'}}
    * ```
    * @category Configuration
-   * @since v2.0
+   * @since v2.0.0
    */
   setQueryDefinition<RootTableId extends TableIdFromSchema<Schemas[0]>>(
     queryId: Id,
@@ -1929,6 +1794,11 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
 
   /**
    * The delQueryDefinition method removes an existing query definition.
+   * @param queryId The Id of the query to remove.
+   * @returns A reference to the Queries object.
+   * @example
+   * This example creates a Store, creates a Queries object, defines a simple
+   * query, and then removes it.
    *
    * This has schema-based typing. The following is a simplified representation:
    *
@@ -1936,12 +1806,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * delQueryDefinition(queryId: Id): Queries;
    * ```
    *
-   * @param queryId The Id of the query to remove.
-   * @returns A reference to the Queries object.
-   * @example
-   * This example creates a Store, creates a Queries object, defines a simple
-   * query, and then removes it.
-   *
    * ```js
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
@@ -1962,13 +1826,17 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> []
    * ```
    * @category Configuration
-   * @since v2.0
+   * @since v2.0.0
    */
   delQueryDefinition(queryId: Id): Queries<Schemas>;
 
   /**
    * The getStore method returns a reference to the underlying Store that is
    * backing this Queries object.
+   * @returns A reference to the Store.
+   * @example
+   * This example creates a Queries object against a newly-created Store and
+   * then gets its reference in order to update its data.
    *
    * This has schema-based typing. The following is a simplified representation:
    *
@@ -1976,11 +1844,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * getStore(): Store;
    * ```
    *
-   * @returns A reference to the Store.
-   * @example
-   * This example creates a Queries object against a newly-created Store and
-   * then gets its reference in order to update its data.
-   *
    * ```js
    * const queries = createQueries(createStore());
    * queries.setQueryDefinition('dogColors', 'pets', ({select, where}) => {
@@ -1994,14 +1857,13 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> {fido: {color: 'brown'}}
    * ```
    * @category Getter
-   * @since v2.0
+   * @since v2.0.0
    */
   getStore(): Store<Schemas>;
 
   /**
    * The getQueryIds method returns an array of the query Ids registered with
    * this Queries object.
-   *
    * @returns An array of Ids.
    * @example
    * This example creates a Queries object with two definitions, and then gets
@@ -2022,7 +1884,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> ['dogColors', 'catColors']
    * ```
    * @category Getter
-   * @since v2.0
+   * @since v2.0.0
    */
   getQueryIds(): Ids;
 
@@ -2033,7 +1895,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * This method is useful for iterating over all the queries in a functional
    * style. The `queryCallback` parameter is a QueryCallback function that will
    * be called with the Id of each query.
-   *
    * @param queryCallback The function that should be called for every query.
    * @example
    * This example iterates over each query in a Queries object.
@@ -2056,14 +1917,13 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> 'catColors'
    * ```
    * @category Iterator
-   * @since v2.0
+   * @since v2.0.0
    */
   forEachQuery(queryCallback: QueryCallback): void;
 
   /**
    * The hasQuery method returns a boolean indicating whether a given query
    * exists in the Queries object.
-   *
    * @param queryId The Id of a possible query in the Queries object.
    * @returns Whether a query with that Id exists.
    * @example
@@ -2085,7 +1945,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> false
    * ```
    * @category Getter
-   * @since v2.0
+   * @since v2.0.0
    */
   hasQuery(queryId: Id): boolean;
 
@@ -2100,7 +1960,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * ```
    *
    * If the query Id is invalid, the method returns `undefined`.
-   *
    * @param queryId The Id of a query.
    * @returns The Id of the Table backing the query, or `undefined`.
    * @example
@@ -2124,7 +1983,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Getter
-   * @since v2.0
+   * @since v2.0.0
    */
   getTableId<TableId extends TableIdFromSchema<Schemas[0]>>(
     queryId: Id,
@@ -2139,7 +1998,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * returns a copy of, rather than a reference to the underlying data, so
    * changes made to the returned object are not made to the query results
    * themselves.
-   *
    * @param queryId The Id of a query.
    * @returns An object containing the entire data of the ResultTable of the
    * query.
@@ -2172,7 +2030,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> {}
    * ```
    * @category Result
-   * @since v2.0
+   * @since v2.0.0
    */
   getResultTable(queryId: Id): ResultTable;
 
@@ -2184,7 +2042,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * the query Id is invalid, the method returns an empty array. Similarly, it
    * returns a copy of, rather than a reference to the list of Ids, so changes
    * made to the list object are not made to the query results themselves.
-   *
    * @param queryId The Id of a query.
    * @returns An array of the Ids of every ResultRow in the result of the query.
    * @example
@@ -2215,7 +2072,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> []
    * ```
    * @category Result
-   * @since v2.0
+   * @since v2.0.0
    */
   getResultRowIds(queryId: Id): Ids;
 
@@ -2236,7 +2093,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * results yourself, especially when the ResultTable is large. For a
    * performant approach to tracking the sorted ResultRow Ids when they change,
    * use the addResultSortedRowIdsListener method.
-   *
    * @param queryId The Id of a query.
    * @param cellId The Id of the ResultCell whose values are used for the
    * sorting, or `undefined` to by sort the ResultRow Id itself.
@@ -2275,7 +2131,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> []
    * ```
    * @category Result
-   * @since v2.0
+   * @since v2.0.0
    */
   getResultSortedRowIds(
     queryId: Id,
@@ -2294,7 +2150,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * Similarly, it returns a copy of, rather than a reference to the underlying
    * data, so changes made to the returned object are not made to the query
    * results themselves.
-   *
    * @param queryId The Id of a query.
    * @param rowId The Id of the ResultRow in the ResultTable.
    * @returns An object containing the entire data of the ResultRow in the
@@ -2327,7 +2182,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> {}
    * ```
    * @category Result
-   * @since v2.0
+   * @since v2.0.0
    */
   getResultRow(queryId: Id, rowId: Id): ResultRow;
 
@@ -2340,7 +2195,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * Similarly, it returns a copy of, rather than a reference to the list of
    * Ids, so changes made to the list object are not made to the query results
    * themselves.
-   *
    * @param queryId The Id of a query.
    * @param rowId The Id of the ResultRow in the ResultTable.
    * @returns An array of the Ids of every ResultCell in the ResultRow in the
@@ -2373,7 +2227,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> []
    * ```
    * @category Result
-   * @since v2.0
+   * @since v2.0.0
    */
   getResultCellIds(queryId: Id, rowId: Id): Ids;
 
@@ -2384,7 +2238,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * This has the same behavior as a Store's getCell method. For example, if the
    * query, or ResultRow, or ResultCell Id is invalid, the method returns
    * `undefined`.
-   *
    * @param queryId The Id of a query.
    * @param rowId The Id of the ResultRow in the ResultTable.
    * @param cellId The Id of the ResultCell in the ResultRow.
@@ -2417,14 +2270,13 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Result
-   * @since v2.0
+   * @since v2.0.0
    */
   getResultCell(queryId: Id, rowId: Id, cellId: Id): ResultCellOrUndefined;
 
   /**
    * The hasResultTable method returns a boolean indicating whether a given
    * ResultTable exists.
-   *
    * @param queryId The Id of a possible query.
    * @returns Whether a ResultTable for that query Id exists.
    * @example
@@ -2452,14 +2304,13 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> false
    * ```
    * @category Result
-   * @since v2.0
+   * @since v2.0.0
    */
   hasResultTable(queryId: Id): boolean;
 
   /**
    * The hasResultRow method returns a boolean indicating whether a given
    * ResultRow exists.
-   *
    * @param queryId The Id of a possible query.
    * @param rowId The Id of a possible ResultRow.
    * @returns Whether a ResultRow for that Id exists.
@@ -2488,14 +2339,13 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> false
    * ```
    * @category Result
-   * @since v2.0
+   * @since v2.0.0
    */
   hasResultRow(queryId: Id, rowId: Id): boolean;
 
   /**
    * The hasResultCell method returns a boolean indicating whether a given
    * ResultCell exists.
-   *
    * @param queryId The Id of a possible query.
    * @param rowId The Id of a possible ResultRow.
    * @param cellId The Id of a possible ResultCell.
@@ -2525,7 +2375,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> false
    * ```
    * @category Result
-   * @since v2.0
+   * @since v2.0.0
    */
   hasResultCell(queryId: Id, rowId: Id, cellId: Id): boolean;
 
@@ -2538,7 +2388,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * ResultTableCallback function that will be called with the Id of each
    * ResultTable, and with a function that can then be used to iterate over each
    * ResultRow of the ResultTable, should you wish.
-   *
    * @param tableCallback The function that should be called for every query's
    * ResultTable.
    * @example
@@ -2572,7 +2421,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> '- felix'
    * ```
    * @category Iterator
-   * @since v2.0
+   * @since v2.0.0
    */
   forEachResultTable(tableCallback: ResultTableCallback): void;
 
@@ -2585,7 +2434,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * ResultRowCallback function that will be called with the Id of each
    * ResultRow, and with a function that can then be used to iterate over each
    * ResultCell of the ResultRow, should you wish.
-   *
    * @param queryId The Id of a query.
    * @param rowCallback The function that should be called for every ResultRow
    * of the query's ResultTable.
@@ -2618,7 +2466,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> '- color'
    * ```
    * @category Iterator
-   * @since v2.0
+   * @since v2.0.0
    */
   forEachResultRow(queryId: Id, rowCallback: ResultRowCallback): void;
 
@@ -2630,7 +2478,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * of the query in a functional style. The `cellCallback` parameter is a
    * ResultCellCallback function that will be called with the Id and value of
    * each ResultCell.
-   *
    * @param queryId The Id of a query.
    * @param rowId The Id of a ResultRow in the query's ResultTable.
    * @param cellCallback The function that should be called for every ResultCell
@@ -2662,7 +2509,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> 'color: brown'
    * ```
    * @category Iterator
-   * @since v2.0
+   * @since v2.0.0
    */
   forEachResultCell(
     queryId: Id,
@@ -2688,7 +2535,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * You can either listen to a single ResultTable (by specifying a query Id as
    * the method's first parameter) or changes to any ResultTable (by providing a
    * `null` wildcard).
-   *
    * @param queryId The Id of the query to listen to, or `null` as a wildcard.
    * @param listener The function that will be called whenever data in the
    * matching ResultTable changes.
@@ -2763,7 +2609,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
-   * @since v2.0
+   * @since v2.0.0
    */
   addResultTableListener(
     queryId: IdOrNull,
@@ -2795,7 +2641,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * You can either listen to a single ResultTable (by specifying a query Id as
    * the method's first parameter) or changes to any ResultTable (by providing a
    * `null` wildcard).
-   *
    * @param queryId The Id of the query to listen to, or `null` as a wildcard.
    * @param listener The function that will be called whenever the ResultRow Ids
    * in the ResultTable change.
@@ -2870,7 +2715,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
-   * @since v2.0
+   * @since v2.0.0
    */
   addResultRowIdsListener(
     queryId: IdOrNull,
@@ -2916,7 +2761,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * should be in descending order. The `offset` and `limit` parameters are used
    * to paginate results, but default to `0` and `undefined` to return all
    * available ResultRow Ids if not specified.
-   *
    * @param queryId The Id of the query to listen to.
    * @param cellId The Id of the ResultCell whose values are used for the
    * sorting, or `undefined` to by sort the ResultRow Id itself.
@@ -3010,7 +2854,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
-   * @since v2.0
+   * @since v2.0.0
    */
   addResultSortedRowIdsListener(
     queryId: Id,
@@ -3048,7 +2892,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * wildcarded with `null`. You can listen to a specific ResultRow in a
    * specific query, any ResultRow in a specific query, a specific ResultRow in
    * any query, or any ResultRow in any query.
-   *
    * @param queryId The Id of the query to listen to, or `null` as a wildcard.
    * @param rowId The Id of the ResultRow to listen to, or `null` as a wildcard.
    * @param listener The function that will be called whenever data in the
@@ -3126,7 +2969,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
-   * @since v2.0
+   * @since v2.0.0
    */
   addResultRowListener(
     queryId: IdOrNull,
@@ -3165,7 +3008,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * wildcarded with `null`. You can listen to a specific ResultRow in a
    * specific query, any ResultRow in a specific query, a specific ResultRow in
    * any query, or any ResultRow in any query.
-   *
    * @param queryId The Id of the query to listen to, or `null` as a wildcard.
    * @param rowId The Id of the ResultRow to listen to, or `null` as a wildcard.
    * @param listener The function that will be called whenever the ResultCell
@@ -3248,7 +3090,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
-   * @since v2.0
+   * @since v2.0.0
    */
   addResultCellIdsListener(
     queryId: IdOrNull,
@@ -3286,7 +3128,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * be wildcarded with `null`. You can listen to a specific ResultCell in a
    * specific ResultRow in a specific query, any ResultCell in any ResultRow in
    * any query, for example - or every other combination of wildcards.
-   *
    * @param queryId The Id of the query to listen to, or `null` as a wildcard.
    * @param rowId The Id of the ResultRow to listen to, or `null` as a wildcard.
    * @param cellId The Id of the ResultCell to listen to, or `null` as a
@@ -3375,7 +3216,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
-   * @since v2.0
+   * @since v2.0.0
    */
   addResultCellListener(
     queryId: IdOrNull,
@@ -3396,7 +3237,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    *
    * Use the Id returned by the addMetricListener method. Note that the Queries
    * object may re-use this Id for future listeners added to it.
-   *
    * @param listenerId The Id of the listener to remove.
    * @returns A reference to the Queries object.
    * @example
@@ -3432,7 +3272,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // The listener is not called.
    * ```
    * @category Listener
-   * @since v2.0
+   * @since v2.0.0
    */
   delListener(listenerId: Id): Queries<Schemas>;
 
@@ -3442,7 +3282,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    *
    * This guarantees that all of the listeners that the object registered with
    * the underlying Store are removed and it can be correctly garbage collected.
-   *
    * @example
    * This example creates a Store, adds a Queries object with a definition (that
    * registers a RowListener with the underlying Store), and then destroys it
@@ -3468,7 +3307,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> 0
    * ```
    * @category Lifecycle
-   * @since v2.0
+   * @since v2.0.0
    */
   destroy(): void;
 
@@ -3481,7 +3320,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * return an empty object. 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
@@ -3498,7 +3336,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> 0
    * ```
    * @category Development
-   * @since v2.0
+   * @since v2.0.0
    */
   getListenerStats(): QueriesListenerStats;
 }
@@ -3516,7 +3354,6 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
  * A given Store can only have one Queries object associated with it. If you
  * call this function twice on the same Store, your second call will return a
  * reference to the Queries object created by the first.
- *
  * @param store The Store for which to register query definitions.
  * @returns A reference to the new Queries object.
  * @example
@@ -3540,7 +3377,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
  * // -> true
  * ```
  * @category Creation
- * @since v2.0
+ * @since v2.0.0
  */
 export function createQueries<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,