tinybase 5.0.0-beta.27 → 5.0.0-beta.28

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

@@ -8,6 +8,7 @@
  * listeners for when they change.
  * @packageDocumentation
  * @module indexes
+ * @since v1.0.0
  */
 
 import type {GetCell, RowCallback, Store} from '../store/index.d.cts';
@@ -24,6 +25,7 @@ import type {Id, IdOrNull, Ids, SortKey} from '../common/index.d.cts';
  * enumerate and access its structure with the getSliceIds method and
  * getSliceRowIds method.
  * @category Concept
+ * @since v1.0.0
  */
 export type Index = {[sliceId: Id]: Slice};
 
@@ -37,6 +39,7 @@ export type Index = {[sliceId: Id]: Slice};
  * Note that the Slice type is not actually used in the API, and you instead get
  * Row Ids directly with the getSliceRowIds method.
  * @category Concept
+ * @since v1.0.0
  */
 export type Slice = Ids;
 
@@ -51,6 +54,7 @@ export type Slice = Ids;
  * @param forEachRow A function that will let you iterate over the Slice objects
  * in this Index.
  * @category Callback
+ * @since v1.0.0
  */
 export type IndexCallback = (
   indexId: Id,
@@ -68,6 +72,7 @@ export type IndexCallback = (
  * @param forEachRow A function that will let you iterate over the Row objects
  * in this Slice.
  * @category Callback
+ * @since v1.0.0
  */
 export type SliceCallback = (
   sliceId: Id,
@@ -84,6 +89,7 @@ export type SliceCallback = (
  * When called, an IndexIdsListener is given a reference to the Indexes object.
  * @param indexes A reference to the Indexes object that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type IndexIdsListener = (indexes: Indexes) => void;
 
@@ -99,6 +105,7 @@ export type IndexIdsListener = (indexes: Indexes) => void;
  * @param indexes A reference to the Indexes object that changed.
  * @param indexId The Id of the Index that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type SliceIdsListener = (indexes: Indexes, indexId: Id) => void;
 
@@ -116,6 +123,7 @@ export type SliceIdsListener = (indexes: Indexes, indexId: Id) => void;
  * @param indexId The Id of the Index that changed.
  * @param sliceId The Id of the Slice that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type SliceRowIdsListener = (
   indexes: Indexes,
@@ -129,16 +137,21 @@ export type SliceRowIdsListener = (
  *
  * A IndexesListenerStats object is returned from the getListenerStats method.
  * @category Development
+ * @since v1.0.0
  */
 export type IndexesListenerStats = {
   /**
    * The number of SlideIdsListener functions registered with the Indexes
    * object.
+   * @category Stat
+   * @since v1.0.0
    */
   sliceIds: number;
   /**
    * The number of SliceRowIdsListener functions registered with the Indexes
    * object.
+   * @category Stat
+   * @since v1.0.0
    */
   sliceRowIds: number;
 };
@@ -193,12 +206,13 @@ export type IndexesListenerStats = {
  * indexes.delListener(listenerId);
  * indexes.destroy();
  * ```
- * @see Metrics And Indexes guides
+ * @see Using Indexes guides
  * @see Rolling Dice demos
  * @see Country demo
  * @see Todo App demos
  * @see Word Frequencies demo
  * @category Indexes
+ * @since v1.0.0
  */
 export interface Indexes {
   //
@@ -360,6 +374,7 @@ export interface Indexes {
    * // -> ['felix', 'fido']
    * ```
    * @category Configuration
+   * @since v1.0.0
    */
   setIndexDefinition(
     indexId: Id,
@@ -397,6 +412,7 @@ export interface Indexes {
    * // -> []
    * ```
    * @category Configuration
+   * @since v1.0.0
    */
   delIndexDefinition(indexId: Id): Indexes;
 
@@ -418,6 +434,7 @@ export interface Indexes {
    * // -> ['dog']
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getStore(): Store;
 
@@ -440,6 +457,7 @@ export interface Indexes {
    * // -> ['bySpecies', 'byColor']
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getIndexIds(): Ids;
 
@@ -481,6 +499,7 @@ export interface Indexes {
    * // -> '- black'
    * ```
    * @category Iterator
+   * @since v1.0.0
    */
   forEachIndex(indexCallback: IndexCallback): void;
 
@@ -519,6 +538,7 @@ export interface Indexes {
    * // -> '- felix'
    * ```
    * @category Iterator
+   * @since v1.0.0
    */
   forEachSlice(indexId: Id, sliceCallback: SliceCallback): void;
 
@@ -541,6 +561,7 @@ export interface Indexes {
    * // -> false
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   hasIndex(indexId: Id): boolean;
 
@@ -569,6 +590,7 @@ export interface Indexes {
    * // -> false
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   hasSlice(indexId: Id, sliceId: Id): boolean;
 
@@ -595,6 +617,7 @@ export interface Indexes {
    * // -> undefined
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getTableId(indexId: Id): Id | undefined;
 
@@ -628,6 +651,7 @@ export interface Indexes {
    * // -> []
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getSliceIds(indexId: Id): Ids;
 
@@ -665,6 +689,7 @@ export interface Indexes {
    * // -> []
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getSliceRowIds(indexId: Id, sliceId: Id): Ids;
 
@@ -745,6 +770,7 @@ export interface Indexes {
    * indexes.delListener(listenerId);
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   addSliceIdsListener(indexId: IdOrNull, listener: SliceIdsListener): Id;
 
@@ -877,6 +903,7 @@ export interface Indexes {
    * indexes.delListener(listenerId);
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   addSliceRowIdsListener(
     indexId: IdOrNull,
@@ -923,6 +950,7 @@ export interface Indexes {
    * // The listener is not called.
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   delListener(listenerId: Id): Indexes;
 
@@ -957,6 +985,7 @@ export interface Indexes {
    * // -> 0
    * ```
    * @category Lifecycle
+   * @since v1.0.0
    */
   destroy(): void;
 
@@ -991,6 +1020,7 @@ export interface Indexes {
    * // -> {sliceIds: 1, sliceRowIds: 1}
    * ```
    * @category Development
+   * @since v1.0.0
    */
   getListenerStats(): IndexesListenerStats;
   //
@@ -1030,5 +1060,6 @@ export interface Indexes {
  * // -> true
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createIndexes(store: Store): Indexes;

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

@@ -8,6 +8,7 @@
  * listeners for when they change.
  * @packageDocumentation
  * @module indexes
+ * @since v1.0.0
  */
 
 import type {GetCell, RowCallback, Store} from '../store/index.d.ts';
@@ -24,6 +25,7 @@ import type {Id, IdOrNull, Ids, SortKey} from '../common/index.d.ts';
  * enumerate and access its structure with the getSliceIds method and
  * getSliceRowIds method.
  * @category Concept
+ * @since v1.0.0
  */
 export type Index = {[sliceId: Id]: Slice};
 
@@ -37,6 +39,7 @@ export type Index = {[sliceId: Id]: Slice};
  * Note that the Slice type is not actually used in the API, and you instead get
  * Row Ids directly with the getSliceRowIds method.
  * @category Concept
+ * @since v1.0.0
  */
 export type Slice = Ids;
 
@@ -51,6 +54,7 @@ export type Slice = Ids;
  * @param forEachRow A function that will let you iterate over the Slice objects
  * in this Index.
  * @category Callback
+ * @since v1.0.0
  */
 export type IndexCallback = (
   indexId: Id,
@@ -68,6 +72,7 @@ export type IndexCallback = (
  * @param forEachRow A function that will let you iterate over the Row objects
  * in this Slice.
  * @category Callback
+ * @since v1.0.0
  */
 export type SliceCallback = (
   sliceId: Id,
@@ -84,6 +89,7 @@ export type SliceCallback = (
  * When called, an IndexIdsListener is given a reference to the Indexes object.
  * @param indexes A reference to the Indexes object that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type IndexIdsListener = (indexes: Indexes) => void;
 
@@ -99,6 +105,7 @@ export type IndexIdsListener = (indexes: Indexes) => void;
  * @param indexes A reference to the Indexes object that changed.
  * @param indexId The Id of the Index that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type SliceIdsListener = (indexes: Indexes, indexId: Id) => void;
 
@@ -116,6 +123,7 @@ export type SliceIdsListener = (indexes: Indexes, indexId: Id) => void;
  * @param indexId The Id of the Index that changed.
  * @param sliceId The Id of the Slice that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type SliceRowIdsListener = (
   indexes: Indexes,
@@ -129,16 +137,21 @@ export type SliceRowIdsListener = (
  *
  * A IndexesListenerStats object is returned from the getListenerStats method.
  * @category Development
+ * @since v1.0.0
  */
 export type IndexesListenerStats = {
   /**
    * The number of SlideIdsListener functions registered with the Indexes
    * object.
+   * @category Stat
+   * @since v1.0.0
    */
   sliceIds: number;
   /**
    * The number of SliceRowIdsListener functions registered with the Indexes
    * object.
+   * @category Stat
+   * @since v1.0.0
    */
   sliceRowIds: number;
 };
@@ -193,12 +206,13 @@ export type IndexesListenerStats = {
  * indexes.delListener(listenerId);
  * indexes.destroy();
  * ```
- * @see Metrics And Indexes guides
+ * @see Using Indexes guides
  * @see Rolling Dice demos
  * @see Country demo
  * @see Todo App demos
  * @see Word Frequencies demo
  * @category Indexes
+ * @since v1.0.0
  */
 export interface Indexes {
   //
@@ -360,6 +374,7 @@ export interface Indexes {
    * // -> ['felix', 'fido']
    * ```
    * @category Configuration
+   * @since v1.0.0
    */
   setIndexDefinition(
     indexId: Id,
@@ -397,6 +412,7 @@ export interface Indexes {
    * // -> []
    * ```
    * @category Configuration
+   * @since v1.0.0
    */
   delIndexDefinition(indexId: Id): Indexes;
 
@@ -418,6 +434,7 @@ export interface Indexes {
    * // -> ['dog']
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getStore(): Store;
 
@@ -440,6 +457,7 @@ export interface Indexes {
    * // -> ['bySpecies', 'byColor']
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getIndexIds(): Ids;
 
@@ -481,6 +499,7 @@ export interface Indexes {
    * // -> '- black'
    * ```
    * @category Iterator
+   * @since v1.0.0
    */
   forEachIndex(indexCallback: IndexCallback): void;
 
@@ -519,6 +538,7 @@ export interface Indexes {
    * // -> '- felix'
    * ```
    * @category Iterator
+   * @since v1.0.0
    */
   forEachSlice(indexId: Id, sliceCallback: SliceCallback): void;
 
@@ -541,6 +561,7 @@ export interface Indexes {
    * // -> false
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   hasIndex(indexId: Id): boolean;
 
@@ -569,6 +590,7 @@ export interface Indexes {
    * // -> false
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   hasSlice(indexId: Id, sliceId: Id): boolean;
 
@@ -595,6 +617,7 @@ export interface Indexes {
    * // -> undefined
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getTableId(indexId: Id): Id | undefined;
 
@@ -628,6 +651,7 @@ export interface Indexes {
    * // -> []
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getSliceIds(indexId: Id): Ids;
 
@@ -665,6 +689,7 @@ export interface Indexes {
    * // -> []
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getSliceRowIds(indexId: Id, sliceId: Id): Ids;
 
@@ -745,6 +770,7 @@ export interface Indexes {
    * indexes.delListener(listenerId);
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   addSliceIdsListener(indexId: IdOrNull, listener: SliceIdsListener): Id;
 
@@ -877,6 +903,7 @@ export interface Indexes {
    * indexes.delListener(listenerId);
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   addSliceRowIdsListener(
     indexId: IdOrNull,
@@ -923,6 +950,7 @@ export interface Indexes {
    * // The listener is not called.
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   delListener(listenerId: Id): Indexes;
 
@@ -957,6 +985,7 @@ export interface Indexes {
    * // -> 0
    * ```
    * @category Lifecycle
+   * @since v1.0.0
    */
   destroy(): void;
 
@@ -991,6 +1020,7 @@ export interface Indexes {
    * // -> {sliceIds: 1, sliceRowIds: 1}
    * ```
    * @category Development
+   * @since v1.0.0
    */
   getListenerStats(): IndexesListenerStats;
   //
@@ -1030,5 +1060,6 @@ export interface Indexes {
  * // -> true
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createIndexes(store: Store): Indexes;

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

@@ -8,6 +8,7 @@
  * listeners for when they change.
  * @packageDocumentation
  * @module indexes
+ * @since v1.0.0
  */
 
 import type {
@@ -39,6 +40,7 @@ import type {
  * enumerate and access its structure with the getSliceIds method and
  * getSliceRowIds method.
  * @category Concept
+ * @since v1.0.0
  */
 export type Index = {[sliceId: Id]: Slice};
 
@@ -52,6 +54,7 @@ export type Index = {[sliceId: Id]: Slice};
  * Note that the Slice type is not actually used in the API, and you instead get
  * Row Ids directly with the getSliceRowIds method.
  * @category Concept
+ * @since v1.0.0
  */
 export type Slice = Ids;
 
@@ -75,6 +78,7 @@ export type Slice = Ids;
  * @param forEachRow A function that will let you iterate over the Slice objects
  * in this Index.
  * @category Callback
+ * @since v1.0.0
  */
 export type IndexCallback<Schema extends OptionalTablesSchema> = (
   indexId: Id,
@@ -101,6 +105,7 @@ export type IndexCallback<Schema extends OptionalTablesSchema> = (
  * @param forEachRow A function that will let you iterate over the Row objects
  * in this Slice.
  * @category Callback
+ * @since v1.0.0
  */
 export type SliceCallback<Schema extends OptionalTablesSchema> = (
   sliceId: Id,
@@ -123,6 +128,7 @@ export type SliceCallback<Schema extends OptionalTablesSchema> = (
  * When called, an IndexIdsListener is given a reference to the Indexes object.
  * @param indexes A reference to the Indexes object that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type IndexIdsListener<Schemas extends OptionalSchemas> = (
   indexes: Indexes<Schemas>,
@@ -146,6 +152,7 @@ export type IndexIdsListener<Schemas extends OptionalSchemas> = (
  * @param indexes A reference to the Indexes object that changed.
  * @param indexId The Id of the Index that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type SliceIdsListener<Schemas extends OptionalSchemas> = (
   indexes: Indexes<Schemas>,
@@ -176,6 +183,7 @@ export type SliceIdsListener<Schemas extends OptionalSchemas> = (
  * @param indexId The Id of the Index that changed.
  * @param sliceId The Id of the Slice that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type SliceRowIdsListener<Schemas extends OptionalSchemas> = (
   indexes: Indexes<Schemas>,
@@ -189,16 +197,21 @@ export type SliceRowIdsListener<Schemas extends OptionalSchemas> = (
  *
  * A IndexesListenerStats object is returned from the getListenerStats method.
  * @category Development
+ * @since v1.0.0
  */
 export type IndexesListenerStats = {
   /**
    * The number of SlideIdsListener functions registered with the Indexes
    * object.
+   * @category Stat
+   * @since v1.0.0
    */
   sliceIds: number;
   /**
    * The number of SliceRowIdsListener functions registered with the Indexes
    * object.
+   * @category Stat
+   * @since v1.0.0
    */
   sliceRowIds: number;
 };
@@ -253,12 +266,13 @@ export type IndexesListenerStats = {
  * indexes.delListener(listenerId);
  * indexes.destroy();
  * ```
- * @see Metrics And Indexes guides
+ * @see Using Indexes guides
  * @see Rolling Dice demos
  * @see Country demo
  * @see Todo App demos
  * @see Word Frequencies demo
  * @category Indexes
+ * @since v1.0.0
  */
 export interface Indexes<in out Schemas extends OptionalSchemas> {
   /**
@@ -432,6 +446,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // -> ['felix', 'fido']
    * ```
    * @category Configuration
+   * @since v1.0.0
    */
   setIndexDefinition<TableId extends TableIdFromSchema<Schemas[0]>>(
     indexId: Id,
@@ -479,6 +494,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // -> []
    * ```
    * @category Configuration
+   * @since v1.0.0
    */
   delIndexDefinition(indexId: Id): Indexes<Schemas>;
 
@@ -506,6 +522,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // -> ['dog']
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getStore(): Store<Schemas>;
 
@@ -528,6 +545,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // -> ['bySpecies', 'byColor']
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getIndexIds(): Ids;
 
@@ -575,6 +593,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // -> '- black'
    * ```
    * @category Iterator
+   * @since v1.0.0
    */
   forEachIndex(indexCallback: IndexCallback<Schemas[0]>): void;
 
@@ -619,6 +638,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // -> '- felix'
    * ```
    * @category Iterator
+   * @since v1.0.0
    */
   forEachSlice(indexId: Id, sliceCallback: SliceCallback<Schemas[0]>): void;
 
@@ -641,6 +661,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // -> false
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   hasIndex(indexId: Id): boolean;
 
@@ -669,6 +690,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // -> false
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   hasSlice(indexId: Id, sliceId: Id): boolean;
 
@@ -701,6 +723,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getTableId<TableId extends TableIdFromSchema<Schemas[0]>>(
     indexId: Id,
@@ -736,6 +759,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // -> []
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getSliceIds(indexId: Id): Ids;
 
@@ -773,6 +797,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // -> []
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getSliceRowIds(indexId: Id, sliceId: Id): Ids;
 
@@ -905,6 +930,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * indexes.delListener(listenerId);
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   addSliceIdsListener(
     indexId: IdOrNull,
@@ -1010,6 +1036,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * indexes.delListener(listenerId);
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   addSliceRowIdsListener(
     indexId: IdOrNull,
@@ -1062,6 +1089,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // The listener is not called.
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   delListener(listenerId: Id): Indexes<Schemas>;
 
@@ -1096,6 +1124,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // -> 0
    * ```
    * @category Lifecycle
+   * @since v1.0.0
    */
   destroy(): void;
 
@@ -1130,6 +1159,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
    * // -> {sliceIds: 1, sliceRowIds: 1}
    * ```
    * @category Development
+   * @since v1.0.0
    */
   getListenerStats(): IndexesListenerStats;
 }
@@ -1174,6 +1204,7 @@ export interface Indexes<in out Schemas extends OptionalSchemas> {
  * // -> true
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createIndexes<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,