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

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

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

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

@@ -738,10 +738,8 @@ export interface MergeableStore extends Store {
    * store2.setDefaultContent([{}, {employees: 4}]);
    * console.log(store2.getMergeableContent());
    * // -> [[{}, "", 0], [{"employees": [4, "", 2414055963]}, "", 3035768673]]
-   * ```
    *
    * store2.merge(store1);
-   *
    * console.log(store2.getContent());
    * // -> [{}, {employees: 3}]
    * ```

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

@@ -738,10 +738,8 @@ export interface MergeableStore extends Store {
    * store2.setDefaultContent([{}, {employees: 4}]);
    * console.log(store2.getMergeableContent());
    * // -> [[{}, "", 0], [{"employees": [4, "", 2414055963]}, "", 3035768673]]
-   * ```
    *
    * store2.merge(store1);
-   *
    * console.log(store2.getContent());
    * // -> [{}, {employees: 3}]
    * ```

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

@@ -900,10 +900,8 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * store2.setDefaultContent([{}, {employees: 4}]);
    * console.log(store2.getMergeableContent());
    * // -> [[{}, "", 0], [{"employees": [4, "", 2414055963]}, "", 3035768673]]
-   * ```
    *
    * store2.merge(store1);
-   *
    * console.log(store2.getContent());
    * // -> [{}, {employees: 3}]
    * ```
@@ -1233,6 +1231,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * // -> {pets: {0: {species: 'dog', sold: false}}}
    * ```
    * @category Setter
+   * @since v1.0.0
    */
   setSchema<TS extends TablesSchema, VS extends ValuesSchema>(
     tablesSchema: TS,
@@ -1263,6 +1262,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * // -> '{}'
    * ```
    * @category Deleter
+   * @since v1.0.0
    */
   delTablesSchema<
     ValuesSchema extends OptionalValuesSchema = Schemas[1],

package/@types/mergeable-store/with-schemas/index.d.ts

@@ -900,10 +900,8 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * store2.setDefaultContent([{}, {employees: 4}]);
    * console.log(store2.getMergeableContent());
    * // -> [[{}, "", 0], [{"employees": [4, "", 2414055963]}, "", 3035768673]]
-   * ```
    *
    * store2.merge(store1);
-   *
    * console.log(store2.getContent());
    * // -> [{}, {employees: 3}]
    * ```
@@ -1233,6 +1231,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * // -> {pets: {0: {species: 'dog', sold: false}}}
    * ```
    * @category Setter
+   * @since v1.0.0
    */
   setSchema<TS extends TablesSchema, VS extends ValuesSchema>(
     tablesSchema: TS,
@@ -1263,6 +1262,7 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
    * // -> '{}'
    * ```
    * @category Deleter
+   * @since v1.0.0
    */
   delTablesSchema<
     ValuesSchema extends OptionalValuesSchema = Schemas[1],

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

@@ -8,6 +8,7 @@
  * listeners for when they change.
  * @packageDocumentation
  * @module metrics
+ * @since v1.0.0
  */
 
 import type {GetCell, Store} from '../store/index.d.cts';
@@ -17,6 +18,7 @@ import type {Id, IdOrNull, Ids} from '../common/index.d.cts';
  * The Metric type is simply an alias, but represents a number formed by
  * aggregating multiple other numbers together.
  * @category Metric
+ * @since v1.0.0
  */
 export type Metric = number;
 
@@ -30,6 +32,7 @@ export type Metric = number;
  * @param metricId The Id of the Metric that the callback can operate on.
  * @param metric The value of the Metric.
  * @category Callback
+ * @since v1.0.0
  */
 export type MetricCallback = (metricId: Id, metric?: Metric) => void;
 
@@ -45,6 +48,7 @@ export type MetricCallback = (metricId: Id, metric?: Metric) => void;
  * @param length The length of the array of numbers in the Metric's aggregation.
  * @returns The value of the Metric.
  * @category Aggregators
+ * @since v1.0.0
  */
 export type MetricAggregate = (numbers: number[], length: number) => Metric;
 
@@ -61,7 +65,7 @@ export type MetricAggregate = (numbers: number[], length: number) => Metric;
  * being added, return `undefined` and the Metric will be completely
  * recalculated.
  *
- * Where possible, if you are providing a custom MetricAggregate, seek an
+ * When possible, if you are providing a custom MetricAggregate, seek an
  * implementation of an MetricAggregateAdd function that can reduce the
  * complexity cost of growing the input data set. See the setMetricDefinition
  * method for more examples.
@@ -70,6 +74,7 @@ export type MetricAggregate = (numbers: number[], length: number) => Metric;
  * @param length The length of the array of numbers in the Metric's aggregation.
  * @returns The new value of the Metric.
  * @category Aggregators
+ * @since v1.0.0
  */
 export type MetricAggregateAdd = (
   metric: Metric,
@@ -93,7 +98,7 @@ export type MetricAggregateAdd = (
  * values, and the previous minimum is being removed. The whole of the rest of
  * the list will need to be re-scanned to find a new minimum.
  *
- * Where possible, if you are providing a custom MetricAggregate, seek an
+ * When possible, if you are providing a custom MetricAggregate, seek an
  * implementation of an MetricAggregateRemove function that can reduce the
  * complexity cost of shrinking the input data set. See the setMetricDefinition
  * method for more examples.
@@ -102,6 +107,7 @@ export type MetricAggregateAdd = (
  * @param length The length of the array of numbers in the Metric's aggregation.
  * @returns The new value of the Metric.
  * @category Aggregators
+ * @since v1.0.0
  */
 export type MetricAggregateRemove = (
   metric: Metric,
@@ -122,7 +128,7 @@ export type MetricAggregateRemove = (
  * If it is not possible to shortcut the aggregation based on just one value
  * changing, return `undefined` and the Metric will be completely recalculated.
  *
- * Where possible, if you are providing a custom MetricAggregate, seek an
+ * When possible, if you are providing a custom MetricAggregate, seek an
  * implementation of an MetricAggregateReplace function that can reduce the
  * complexity cost of changing the input data set in place. See the
  * setMetricDefinition method for more examples.
@@ -132,6 +138,7 @@ export type MetricAggregateRemove = (
  * @param length The length of the array of numbers in the Metric's aggregation.
  * @returns The new value of the Metric.
  * @category Aggregators
+ * @since v1.0.0
  */
 export type MetricAggregateReplace = (
   metric: Metric,
@@ -150,6 +157,7 @@ export type MetricAggregateReplace = (
  * When called, a MetricIdsListener is given a reference to the Metrics object.
  * @param metrics A reference to the Metrics object that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type MetricIdsListener = (metrics: Metrics) => void;
 
@@ -171,6 +179,7 @@ export type MetricIdsListener = (metrics: Metrics) => void;
  * @param newMetric The new value of the Metric that changed.
  * @param oldMetric The old value of the Metric that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type MetricListener = (
   metrics: Metrics,
@@ -185,10 +194,13 @@ export type MetricListener = (
  *
  * A MetricsListenerStats object is returned from the getListenerStats method.
  * @category Development
+ * @since v1.0.0
  */
 export type MetricsListenerStats = {
   /**
    * The number of MetricListener functions registered with the Metrics object.
+   * @category Stat
+   * @since v1.0.0
    */
   metric: number;
 };
@@ -243,11 +255,12 @@ export type MetricsListenerStats = {
  * metrics.delListener(listenerId);
  * metrics.destroy();
  * ```
- * @see Metrics And Indexes guides
+ * @see Using Metrics guides
  * @see Rolling Dice demos
  * @see Country demo
  * @see Todo App demos
  * @category Metrics
+ * @since v1.0.0
  */
 export interface Metrics {
   //
@@ -424,6 +437,7 @@ export interface Metrics {
    * // -> 2.5
    * ```
    * @category Configuration
+   * @since v1.0.0
    */
   setMetricDefinition(
     metricId: Id,
@@ -462,6 +476,7 @@ export interface Metrics {
    * // -> []
    * ```
    * @category Configuration
+   * @since v1.0.0
    */
   delMetricDefinition(metricId: Id): Metrics;
 
@@ -483,6 +498,7 @@ export interface Metrics {
    * // -> 1
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getStore(): Store;
 
@@ -505,6 +521,7 @@ export interface Metrics {
    * // -> ['speciesCount', 'petsCount']
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getMetricIds(): Ids;
 
@@ -538,6 +555,7 @@ export interface Metrics {
    * // -> ['lowestPrice', 1]
    * ```
    * @category Iterator
+   * @since v1.0.0
    */
   forEachMetric(metricCallback: MetricCallback): void;
 
@@ -565,6 +583,7 @@ export interface Metrics {
    * // -> true
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   hasMetric(metricId: Id): boolean;
 
@@ -591,6 +610,7 @@ export interface Metrics {
    * // -> undefined
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getTableId(metricId: Id): Id | undefined;
 
@@ -625,6 +645,7 @@ export interface Metrics {
    * // -> undefined
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getMetric(metricId: Id): Metric | undefined;
 
@@ -748,6 +769,7 @@ export interface Metrics {
    * metrics.delListener(listenerId);
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   addMetricListener(metricId: IdOrNull, listener: MetricListener): Id;
 
@@ -789,6 +811,7 @@ export interface Metrics {
    * // The listener is not called.
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   delListener(listenerId: Id): Metrics;
 
@@ -823,6 +846,7 @@ export interface Metrics {
    * // -> 0
    * ```
    * @category Lifecycle
+   * @since v1.0.0
    */
   destroy(): void;
 
@@ -849,6 +873,7 @@ export interface Metrics {
    * // -> {metric: 1}
    * ```
    * @category Development
+   * @since v1.0.0
    */
   getListenerStats(): MetricsListenerStats;
   //
@@ -888,5 +913,6 @@ export interface Metrics {
  * // -> true
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createMetrics(store: Store): Metrics;