tinybase 4.0.0-beta.1 → 4.0.0-beta.3

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

@@ -9,7 +9,7 @@
  *
  * @packageDocumentation
  * @module queries
- * @since v2.0.0
+ * @since v2.0
  */
 
 import {
@@ -99,7 +99,7 @@ export type ResultCellOrUndefined = ResultCell | undefined;
  * @param length The length of the array of Cell values to be aggregated.
  * @returns The value of the aggregation.
  * @category Aggregators
- * @since v2.0.0
+ * @since v2.0
  */
 export type Aggregate = (cells: ResultCell[], length: number) => ResultCell;
 
@@ -125,7 +125,7 @@ export type Aggregate = (cells: ResultCell[], length: number) => ResultCell;
  * @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.0
+ * @since v2.0
  */
 export type AggregateAdd = (
   current: ResultCell,
@@ -158,7 +158,7 @@ export type AggregateAdd = (
  * @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.0
+ * @since v2.0
  */
 export type AggregateRemove = (
   current: ResultCell,
@@ -190,7 +190,7 @@ export type AggregateRemove = (
  * @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.0
+ * @since v2.0
  */
 export type AggregateReplace = (
   current: ResultCell,
@@ -208,7 +208,7 @@ export type AggregateReplace = (
  *
  * @param queryId The Id of the query that the callback can operate on.
  * @category Callback
- * @since v2.0.0
+ * @since v2.0
  */
 export type QueryCallback = (queryId: Id) => void;
 
@@ -290,7 +290,7 @@ export type ResultCellCallback = (cellId: Id, cell: ResultCell) => void;
  * @param getCellChange A function that returns information about any
  * ResultCell's changes.
  * @category Listener
- * @since v2.0.0
+ * @since v2.0
  */
 export type ResultTableListener<Schemas extends OptionalSchemas> = (
   queries: Queries<Schemas>,
@@ -319,7 +319,7 @@ export type ResultTableListener<Schemas extends OptionalSchemas> = (
  * @param tableId The Id of the ResultTable that changed, which is also the
  * query Id.
  * @category Listener
- * @since v2.0.0
+ * @since v2.0
  */
 export type ResultRowIdsListener<Schemas extends OptionalSchemas> = (
   queries: Queries<Schemas>,
@@ -365,7 +365,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.0
+ * @since v2.0
  */
 export type ResultSortedRowIdsListener<Schemas extends OptionalSchemas> = (
   queries: Queries<Schemas>,
@@ -407,7 +407,7 @@ export type ResultSortedRowIdsListener<Schemas extends OptionalSchemas> = (
  * @param getCellChange A function that returns information about any
  * ResultCell's changes.
  * @category Listener
- * @since v2.0.0
+ * @since v2.0
  */
 export type ResultRowListener<Schemas extends OptionalSchemas> = (
   queries: Queries<Schemas>,
@@ -442,7 +442,7 @@ export type ResultRowListener<Schemas extends OptionalSchemas> = (
  * query Id.
  * @param rowId The Id of the ResultRow that changed.
  * @category Listener
- * @since v2.0.0
+ * @since v2.0
  */
 export type ResultCellIdsListener<Schemas extends OptionalSchemas> = (
   queries: Queries<Schemas>,
@@ -488,7 +488,7 @@ export type ResultCellIdsListener<Schemas extends OptionalSchemas> = (
  * @param getCellChange A function that returns information about any
  * ResultCell's changes.
  * @category Listener
- * @since v2.0.0
+ * @since v2.0
  */
 export type ResultCellListener<Schemas extends OptionalSchemas> = (
   queries: Queries<Schemas>,
@@ -547,7 +547,7 @@ export type ResultCellChange = [
  * and is only populated in a debug build.
  *
  * @category Development
- * @since v2.0.0
+ * @since v2.0
  */
 export type QueriesListenerStats = {
   /**
@@ -581,7 +581,7 @@ export type QueriesListenerStats = {
  * calculated values. See those methods for specific examples.
  *
  * @category Callback
- * @since v2.0.0
+ * @since v2.0
  */
 export type GetTableCell<
   Schema extends OptionalTablesSchema,
@@ -733,7 +733,7 @@ export type GetTableCell<
  * // -> {cujo: {description: 'dog for Carol'}}
  * ```
  * @category Definition
- * @since v2.0.0
+ * @since v2.0
  */
 export type Select<
   Schema extends OptionalTablesSchema,
@@ -851,7 +851,7 @@ export type Select<
  * // -> {cujo: {petSpecies: 'dog', ownerName: 'Carol'}}
  * ```
  * @category Definition
- * @since v2.0.0
+ * @since v2.0
  */
 export type SelectedAs = {
   /**
@@ -1024,7 +1024,7 @@ export type SelectedAs = {
  * // -> {cujo: {description: 'dog in Washington'}}
  * ```
  * @category Definition
- * @since v2.0.0
+ * @since v2.0
  */
 export type Join<
   Schema extends OptionalTablesSchema,
@@ -1203,7 +1203,7 @@ export type Join<
  * // -> {cujo: {buyer: 'Carol', seller: 'Alice'}}
  * ```
  * @category Definition
- * @since v2.0.0
+ * @since v2.0
  */
 export type JoinedAs = {
   /**
@@ -1326,7 +1326,7 @@ export type JoinedAs = {
  * // -> {cujo: {species: 'dog', state: 'WA'}}
  * ```
  * @category Definition
- * @since v2.0.0
+ * @since v2.0
  */
 export type Where<
   Schema extends OptionalTablesSchema,
@@ -1574,7 +1574,7 @@ export type Where<
  * // Both have a parrot at 3. Alice's worm at 1 is excluded from aggregation.
  * ```
  * @category Definition
- * @since v2.0.0
+ * @since v2.0
  */
 export type Group = (
   selectedCellId: Id,
@@ -1620,7 +1620,7 @@ export type Group = (
  * // -> {1: {species: 'cat', minPrice: 3, maxPrice: 4}}
  * ```
  * @category Definition
- * @since v2.0.0
+ * @since v2.0
  */
 export type GroupedAs = {
   /**
@@ -1715,7 +1715,7 @@ export type GroupedAs = {
  * // Parrots are filtered out because they have zero range in price.
  * ```
  * @category Definition
- * @since v2.0.0
+ * @since v2.0
  */
 export type Having = {
   /**
@@ -1833,7 +1833,7 @@ export type Having = {
  * @see Car Analysis demo
  * @see Movie Database demo
  * @category Queries
- * @since v2.0.0
+ * @since v2.0
  */
 export interface Queries<in out Schemas extends OptionalSchemas> {
   /**
@@ -1913,7 +1913,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> {fido: {color: 'brown'}, cujo: {color: 'black'}}
    * ```
    * @category Configuration
-   * @since v2.0.0
+   * @since v2.0
    */
   setQueryDefinition<RootTableId extends TableIdFromSchema<Schemas[0]>>(
     queryId: Id,
@@ -1962,7 +1962,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> []
    * ```
    * @category Configuration
-   * @since v2.0.0
+   * @since v2.0
    */
   delQueryDefinition(queryId: Id): Queries<Schemas>;
 
@@ -1994,7 +1994,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> {fido: {color: 'brown'}}
    * ```
    * @category Getter
-   * @since v2.0.0
+   * @since v2.0
    */
   getStore(): Store<Schemas>;
 
@@ -2022,7 +2022,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> ['dogColors', 'catColors']
    * ```
    * @category Getter
-   * @since v2.0.0
+   * @since v2.0
    */
   getQueryIds(): Ids;
 
@@ -2056,7 +2056,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> 'catColors'
    * ```
    * @category Iterator
-   * @since v2.0.0
+   * @since v2.0
    */
   forEachQuery(queryCallback: QueryCallback): void;
 
@@ -2085,7 +2085,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> false
    * ```
    * @category Getter
-   * @since v2.0.0
+   * @since v2.0
    */
   hasQuery(queryId: Id): boolean;
 
@@ -2124,7 +2124,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Getter
-   * @since v2.0.0
+   * @since v2.0
    */
   getTableId<TableId extends TableIdFromSchema<Schemas[0]>>(
     queryId: Id,
@@ -2172,7 +2172,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> {}
    * ```
    * @category Result
-   * @since v2.0.0
+   * @since v2.0
    */
   getResultTable(queryId: Id): ResultTable;
 
@@ -2215,7 +2215,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> []
    * ```
    * @category Result
-   * @since v2.0.0
+   * @since v2.0
    */
   getResultRowIds(queryId: Id): Ids;
 
@@ -2275,7 +2275,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> []
    * ```
    * @category Result
-   * @since v2.0.0
+   * @since v2.0
    */
   getResultSortedRowIds(
     queryId: Id,
@@ -2327,7 +2327,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> {}
    * ```
    * @category Result
-   * @since v2.0.0
+   * @since v2.0
    */
   getResultRow(queryId: Id, rowId: Id): ResultRow;
 
@@ -2373,7 +2373,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> []
    * ```
    * @category Result
-   * @since v2.0.0
+   * @since v2.0
    */
   getResultCellIds(queryId: Id, rowId: Id): Ids;
 
@@ -2417,7 +2417,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Result
-   * @since v2.0.0
+   * @since v2.0
    */
   getResultCell(queryId: Id, rowId: Id, cellId: Id): ResultCellOrUndefined;
 
@@ -2452,7 +2452,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> false
    * ```
    * @category Result
-   * @since v2.0.0
+   * @since v2.0
    */
   hasResultTable(queryId: Id): boolean;
 
@@ -2488,7 +2488,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> false
    * ```
    * @category Result
-   * @since v2.0.0
+   * @since v2.0
    */
   hasResultRow(queryId: Id, rowId: Id): boolean;
 
@@ -2525,7 +2525,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> false
    * ```
    * @category Result
-   * @since v2.0.0
+   * @since v2.0
    */
   hasResultCell(queryId: Id, rowId: Id, cellId: Id): boolean;
 
@@ -2572,7 +2572,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> '- felix'
    * ```
    * @category Iterator
-   * @since v2.0.0
+   * @since v2.0
    */
   forEachResultTable(tableCallback: ResultTableCallback): void;
 
@@ -2618,7 +2618,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> '- color'
    * ```
    * @category Iterator
-   * @since v2.0.0
+   * @since v2.0
    */
   forEachResultRow(queryId: Id, rowCallback: ResultRowCallback): void;
 
@@ -2662,7 +2662,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> 'color: brown'
    * ```
    * @category Iterator
-   * @since v2.0.0
+   * @since v2.0
    */
   forEachResultCell(
     queryId: Id,
@@ -2763,7 +2763,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
-   * @since v2.0.0
+   * @since v2.0
    */
   addResultTableListener(
     queryId: IdOrNull,
@@ -2870,7 +2870,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
-   * @since v2.0.0
+   * @since v2.0
    */
   addResultRowIdsListener(
     queryId: IdOrNull,
@@ -3010,7 +3010,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
-   * @since v2.0.0
+   * @since v2.0
    */
   addResultSortedRowIdsListener(
     queryId: Id,
@@ -3126,7 +3126,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
-   * @since v2.0.0
+   * @since v2.0
    */
   addResultRowListener(
     queryId: IdOrNull,
@@ -3248,7 +3248,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
-   * @since v2.0.0
+   * @since v2.0
    */
   addResultCellIdsListener(
     queryId: IdOrNull,
@@ -3375,7 +3375,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
-   * @since v2.0.0
+   * @since v2.0
    */
   addResultCellListener(
     queryId: IdOrNull,
@@ -3432,7 +3432,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // The listener is not called.
    * ```
    * @category Listener
-   * @since v2.0.0
+   * @since v2.0
    */
   delListener(listenerId: Id): Queries<Schemas>;
 
@@ -3468,7 +3468,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> 0
    * ```
    * @category Lifecycle
-   * @since v2.0.0
+   * @since v2.0
    */
   destroy(): void;
 
@@ -3498,7 +3498,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
    * // -> 0
    * ```
    * @category Development
-   * @since v2.0.0
+   * @since v2.0
    */
   getListenerStats(): QueriesListenerStats;
 }
@@ -3540,7 +3540,7 @@ export interface Queries<in out Schemas extends OptionalSchemas> {
  * // -> true
  * ```
  * @category Creation
- * @since v2.0.0
+ * @since v2.0
  */
 export function createQueries<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,