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

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

@@ -8,6 +8,7 @@
  * of checkpoints change.
  * @packageDocumentation
  * @module checkpoints
+ * @since v1.0.0
  */
 
 import type {Id, IdOrNull, Ids} from '../../common/with-schemas/index.d.ts';
@@ -28,6 +29,7 @@ import type {OptionalSchemas, Store} from '../../store/with-schemas/index.d.ts';
  *   the checkpoints in the redo stack for this Store). They are in
  *   chronological order with the newest checkpoint at the end of the array.
  * @category Identity
+ * @since v1.0.0
  */
 export type CheckpointIds = [Ids, Id | undefined, Ids];
 
@@ -41,6 +43,7 @@ export type CheckpointIds = [Ids, Id | undefined, Ids];
  * @param checkpointId The Id of the Checkpoint that the callback can operate
  * on.
  * @category Callback
+ * @since v1.0.0
  */
 export type CheckpointCallback = (checkpointId: Id, label?: string) => void;
 
@@ -61,6 +64,7 @@ export type CheckpointCallback = (checkpointId: Id, label?: string) => void;
  * object.
  * @param checkpoints A reference to the Checkpoints object that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type CheckpointIdsListener<Schemas extends OptionalSchemas> = (
   checkpoints: Checkpoints<Schemas>,
@@ -87,6 +91,7 @@ export type CheckpointIdsListener<Schemas extends OptionalSchemas> = (
  * @param checkpoints A reference to the Checkpoints object that changed.
  * @param checkpointId The Id of the checkpoint that changed.
  * @category Listener
+ * @since v1.0.0
  */
 export type CheckpointListener<Schemas extends OptionalSchemas> = (
   checkpoints: Checkpoints<Schemas>,
@@ -101,16 +106,21 @@ export type CheckpointListener<Schemas extends OptionalSchemas> = (
  * A CheckpointsListenerStats object is returned from the getListenerStats
  * method.
  * @category Development
+ * @since v1.0.0
  */
 export type CheckpointsListenerStats = {
   /**
    * The number of CheckpointIdsListener functions registered with the
    * Checkpoints object.
+   * @category Stat
+   * @since v1.0.0
    */
   checkpointIds: number;
   /**
    * The number of CheckpointListener functions registered with the Checkpoints
    * object.
+   * @category Stat
+   * @since v1.0.0
    */
   checkpoint: number;
 };
@@ -181,10 +191,11 @@ export type CheckpointsListenerStats = {
  *
  * checkpoints.delListener(listenerId);
  * ```
- * @see Relationships And Checkpoints guides
+ * @see Using Checkpoints guide
  * @see Todo App demos
  * @see Drawing demo
  * @category Checkpoints
+ * @since v1.0.0
  */
 export interface Checkpoints<in out Schemas extends OptionalSchemas> {
   /**
@@ -235,6 +246,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // -> [['1', '2'], '3', []]
    * ```
    * @category Configuration
+   * @since v1.0.0
    */
   setSize(size: number): Checkpoints<Schemas>;
 
@@ -281,6 +293,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // -> 'sale'
    * ```
    * @category Setter
+   * @since v1.0.0
    */
   addCheckpoint(label?: string): Id;
 
@@ -343,6 +356,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Setter
+   * @since v1.0.0
    */
   setCheckpoint(checkpointId: Id, label: string): Checkpoints<Schemas>;
 
@@ -371,6 +385,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // -> [['0'], '1', []]
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getStore(): Store<Schemas>;
 
@@ -412,6 +427,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // -> [['0'], '1', []]
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getCheckpointIds(): CheckpointIds;
 
@@ -443,6 +459,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // -> '1:sale'
    * ```
    * @category Iterator
+   * @since v1.0.0
    */
   forEachCheckpoint(checkpointCallback: CheckpointCallback): void;
 
@@ -466,6 +483,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // -> false
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   hasCheckpoint(checkpointId: Id): boolean;
 
@@ -520,6 +538,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Getter
+   * @since v1.0.0
    */
   getCheckpoint(checkpointId: Id): string | undefined;
 
@@ -576,6 +595,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * checkpoints.delListener(listenerId);
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   addCheckpointIdsListener(listener: CheckpointIdsListener<Schemas>): Id;
 
@@ -645,6 +665,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * checkpoints.delListener(listenerId);
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   addCheckpointListener(
     checkpointId: IdOrNull,
@@ -695,6 +716,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // The listener is not called.
    * ```
    * @category Listener
+   * @since v1.0.0
    */
   delListener(listenerId: Id): Checkpoints<Schemas>;
 
@@ -735,6 +757,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // -> [[], '0', ['1']]
    * ```
    * @category Movement
+   * @since v1.0.0
    */
   goBackward(): Checkpoints<Schemas>;
 
@@ -824,6 +847,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // The original change cannot be redone.
    * ```
    * @category Movement
+   * @since v1.0.0
    */
   goForward(): Checkpoints<Schemas>;
 
@@ -881,6 +905,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // -> [['0'], '1', ['2']]
    * ```
    * @category Movement
+   * @since v1.0.0
    */
   goTo(checkpointId: Id): Checkpoints<Schemas>;
 
@@ -946,6 +971,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * checkpoints.delListener(listenerId);
    * ```
    * @category Lifecycle
+   * @since v1.0.0
    */
   clear(): Checkpoints<Schemas>;
 
@@ -1039,6 +1065,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // -> 0
    * ```
    * @category Lifecycle
+   * @since v1.0.0
    */
   destroy(): void;
 
@@ -1073,6 +1100,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
    * // -> {checkpointIds: 1, checkpoint: 1}
    * ```
    * @category Development
+   * @since v1.0.0
    */
   getListenerStats(): CheckpointsListenerStats;
 }
@@ -1117,6 +1145,7 @@ export interface Checkpoints<in out Schemas extends OptionalSchemas> {
  * // -> true
  * ```
  * @category Creation
+ * @since v1.0.0
  */
 export function createCheckpoints<Schemas extends OptionalSchemas>(
   store: Store<Schemas>,

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

@@ -3,12 +3,14 @@
  * common types used across other modules.
  * @packageDocumentation
  * @module common
+ * @since v1.0.0
  */
 
 /**
  * The Json type is a simple alias for a string, but is used to indicate that
  * the string should be considered to be a JSON serialization of an object.
  * @category General
+ * @since v1.0.0
  */
 export type Json = string;
 
@@ -17,6 +19,7 @@ export type Json = string;
  * indicate that the strings should be considered to be the keys of objects
  * (such as the Row Id strings used in a Table).
  * @category Identity
+ * @since v1.0.0
  */
 export type Ids = Id[];
 
@@ -25,6 +28,7 @@ export type Ids = Id[];
  * string should be considered to be the key of an object (such as a Row Id
  * string used in a Table).
  * @category Identity
+ * @since v1.0.0
  */
 export type Id = string;
 
@@ -34,6 +38,7 @@ export type Id = string;
  * Row Id string used in a Table), and typically `null` indicates a wildcard -
  * such as when used in the Store addRowListener method.
  * @category Identity
+ * @since v1.0.0
  */
 export type IdOrNull = Id | null;
 
@@ -41,6 +46,7 @@ export type IdOrNull = Id | null;
  * The ParameterizedCallback type represents a generic function that will take
  * an optional parameter - such as the handler of a DOM event.
  * @category Callback
+ * @since v1.0.0
  */
 export type ParameterizedCallback<Parameter> = (parameter?: Parameter) => void;
 
@@ -48,12 +54,14 @@ export type ParameterizedCallback<Parameter> = (parameter?: Parameter) => void;
  * The Callback type represents a function that is used as a callback and which
  * does not take a parameter.
  * @category Callback
+ * @since v1.0.0
  */
 export type Callback = () => void;
 
 /**
  * The SortKey type represents a value that can be used by a sort function.
  * @category Parameter
+ * @since v1.0.0
  */
 export type SortKey = string | number | boolean;
 
@@ -106,6 +114,7 @@ export type SortKey = string | number | boolean;
  * // -> ['felix', 'fido']
  * ```
  * @category Convenience
+ * @since v1.0.0
  */
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;
 

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

@@ -3,12 +3,14 @@
  * common types used across other modules.
  * @packageDocumentation
  * @module common
+ * @since v1.0.0
  */
 
 /**
  * The Json type is a simple alias for a string, but is used to indicate that
  * the string should be considered to be a JSON serialization of an object.
  * @category General
+ * @since v1.0.0
  */
 export type Json = string;
 
@@ -17,6 +19,7 @@ export type Json = string;
  * indicate that the strings should be considered to be the keys of objects
  * (such as the Row Id strings used in a Table).
  * @category Identity
+ * @since v1.0.0
  */
 export type Ids = Id[];
 
@@ -25,6 +28,7 @@ export type Ids = Id[];
  * string should be considered to be the key of an object (such as a Row Id
  * string used in a Table).
  * @category Identity
+ * @since v1.0.0
  */
 export type Id = string;
 
@@ -34,6 +38,7 @@ export type Id = string;
  * Row Id string used in a Table), and typically `null` indicates a wildcard -
  * such as when used in the Store addRowListener method.
  * @category Identity
+ * @since v1.0.0
  */
 export type IdOrNull = Id | null;
 
@@ -41,6 +46,7 @@ export type IdOrNull = Id | null;
  * The ParameterizedCallback type represents a generic function that will take
  * an optional parameter - such as the handler of a DOM event.
  * @category Callback
+ * @since v1.0.0
  */
 export type ParameterizedCallback<Parameter> = (parameter?: Parameter) => void;
 
@@ -48,12 +54,14 @@ export type ParameterizedCallback<Parameter> = (parameter?: Parameter) => void;
  * The Callback type represents a function that is used as a callback and which
  * does not take a parameter.
  * @category Callback
+ * @since v1.0.0
  */
 export type Callback = () => void;
 
 /**
  * The SortKey type represents a value that can be used by a sort function.
  * @category Parameter
+ * @since v1.0.0
  */
 export type SortKey = string | number | boolean;
 
@@ -106,6 +114,7 @@ export type SortKey = string | number | boolean;
  * // -> ['felix', 'fido']
  * ```
  * @category Convenience
+ * @since v1.0.0
  */
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;
 

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

@@ -3,12 +3,14 @@
  * common types used across other modules.
  * @packageDocumentation
  * @module common
+ * @since v1.0.0
  */
 
 /**
  * The Json type is a simple alias for a string, but is used to indicate that
  * the string should be considered to be a JSON serialization of an object.
  * @category General
+ * @since v1.0.0
  */
 export type Json = string;
 
@@ -17,6 +19,7 @@ export type Json = string;
  * indicate that the strings should be considered to be the keys of objects
  * (such as the Row Id strings used in a Table).
  * @category Identity
+ * @since v1.0.0
  */
 export type Ids = Id[];
 
@@ -25,6 +28,7 @@ export type Ids = Id[];
  * string should be considered to be the key of an object (such as a Row Id
  * string used in a Table).
  * @category Identity
+ * @since v1.0.0
  */
 export type Id = string;
 
@@ -34,6 +38,7 @@ export type Id = string;
  * Row Id string used in a Table), and typically `null` indicates a wildcard -
  * such as when used in the Store addRowListener method.
  * @category Identity
+ * @since v1.0.0
  */
 export type IdOrNull = Id | null;
 
@@ -41,6 +46,7 @@ export type IdOrNull = Id | null;
  * The ParameterizedCallback type represents a generic function that will take
  * an optional parameter - such as the handler of a DOM event.
  * @category Callback
+ * @since v1.0.0
  */
 export type ParameterizedCallback<Parameter> = (parameter?: Parameter) => void;
 
@@ -48,12 +54,14 @@ export type ParameterizedCallback<Parameter> = (parameter?: Parameter) => void;
  * The Callback type represents a function that is used as a callback and which
  * does not take a parameter.
  * @category Callback
+ * @since v1.0.0
  */
 export type Callback = () => void;
 
 /**
  * The SortKey type represents a value that can be used by a sort function.
  * @category Parameter
+ * @since v1.0.0
  */
 export type SortKey = string | number | boolean;
 
@@ -106,6 +114,7 @@ export type SortKey = string | number | boolean;
  * // -> ['felix', 'fido']
  * ```
  * @category Convenience
+ * @since v1.0.0
  */
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;
 

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

@@ -3,12 +3,14 @@
  * common types used across other modules.
  * @packageDocumentation
  * @module common
+ * @since v1.0.0
  */
 
 /**
  * The Json type is a simple alias for a string, but is used to indicate that
  * the string should be considered to be a JSON serialization of an object.
  * @category General
+ * @since v1.0.0
  */
 export type Json = string;
 
@@ -17,6 +19,7 @@ export type Json = string;
  * indicate that the strings should be considered to be the keys of objects
  * (such as the Row Id strings used in a Table).
  * @category Identity
+ * @since v1.0.0
  */
 export type Ids = Id[];
 
@@ -25,6 +28,7 @@ export type Ids = Id[];
  * string should be considered to be the key of an object (such as a Row Id
  * string used in a Table).
  * @category Identity
+ * @since v1.0.0
  */
 export type Id = string;
 
@@ -34,6 +38,7 @@ export type Id = string;
  * Row Id string used in a Table), and typically `null` indicates a wildcard -
  * such as when used in the Store addRowListener method.
  * @category Identity
+ * @since v1.0.0
  */
 export type IdOrNull = Id | null;
 
@@ -41,6 +46,7 @@ export type IdOrNull = Id | null;
  * The ParameterizedCallback type represents a generic function that will take
  * an optional parameter - such as the handler of a DOM event.
  * @category Callback
+ * @since v1.0.0
  */
 export type ParameterizedCallback<Parameter> = (parameter?: Parameter) => void;
 
@@ -48,12 +54,14 @@ export type ParameterizedCallback<Parameter> = (parameter?: Parameter) => void;
  * The Callback type represents a function that is used as a callback and which
  * does not take a parameter.
  * @category Callback
+ * @since v1.0.0
  */
 export type Callback = () => void;
 
 /**
  * The SortKey type represents a value that can be used by a sort function.
  * @category Parameter
+ * @since v1.0.0
  */
 export type SortKey = string | number | boolean;
 
@@ -106,6 +114,7 @@ export type SortKey = string | number | boolean;
  * // -> ['felix', 'fido']
  * ```
  * @category Convenience
+ * @since v1.0.0
  */
 export function defaultSorter(sortKey1: SortKey, sortKey2: SortKey): number;
 

package/@types/index.d.cts

@@ -1,6 +1,7 @@
 /**
  * This is everything.
  * @packageDocumentation
+ * @since v1.0.0
  */
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment

package/@types/index.d.ts

@@ -1,6 +1,7 @@
 /**
  * This is everything.
  * @packageDocumentation
+ * @since v1.0.0
  */
 
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment