tinybase 0.9.2 → 0.9.3

package/lib/checkpoints.d.ts

@@ -43,6 +43,7 @@ export type CheckpointIds = [Ids, Id | undefined, Ids];
  * When called, a CheckpointIdsListener is given a reference to the Checkpoints
  * object.
  *
+ * @param checkpoints A reference to the Checkpoints object that changed.
  * @category Listener
  */
 export type CheckpointIdsListener = (checkpoints: Checkpoints) => void;
@@ -57,6 +58,8 @@ export type CheckpointIdsListener = (checkpoints: Checkpoints) => void;
  * When called, a CheckpointListener is given a reference to the Checkpoints
  * object, and the Id of the checkpoint whose label changed.
  *
+ * @param checkpoints A reference to the Checkpoints object that changed.
+ * @param checkpointId The Id of the checkpoint that changed.
  * @category Listener
  */
 export type CheckpointListener = (
@@ -75,7 +78,14 @@ export type CheckpointListener = (
  * @category Development
  */
 export type CheckpointsListenerStats = {
+  /**
+   * The number of CheckpointIdsListeners registered with the Checkpoints
+   * object.
+   */
   checkpointIds?: number;
+  /**
+   * The number of CheckpointListeners registered with the Checkpoints object.
+   */
   checkpoint?: number;
 };
 
@@ -101,7 +111,7 @@ export type CheckpointsListenerStats = {
  * to adding a checkpoint, getting the list of available checkpoints, and then
  * registering and removing a listener for them.
  *
- * ```tsx
+ * ```js
  * const store = createStore().setTables({pets: {fido: {sold: false}}});
  *
  * const checkpoints = createCheckpoints(store);
@@ -132,6 +142,7 @@ export type CheckpointsListenerStats = {
  * checkpoints.delListener(listenerId);
  * checkpoints.destroy();
  * ```
+ * @category Checkpoints
  */
 export interface Checkpoints {
   /**
@@ -151,7 +162,7 @@ export interface Checkpoints {
    * of the Checkpoints object dramatically and then creates more than that
    * number of checkpoints to demonstrate the oldest being pruned.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {views: 0}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -196,7 +207,7 @@ export interface Checkpoints {
    * This example creates a Store, adds a Checkpoints object, and adds two
    * checkpoints, one with a label.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -245,7 +256,7 @@ export interface Checkpoints {
    * This example creates a Store, adds a Checkpoints object, and sets two
    * checkpoints, one with a label, which are both then re-labelled.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -288,7 +299,7 @@ export interface Checkpoints {
    * and then gets its reference in order to update its data and set a
    * checkpoint.
    *
-   * ```tsx
+   * ```js
    * const checkpoints = createCheckpoints(createStore());
    * checkpoints.getStore().setCell('pets', 'fido', 'species', 'dog');
    * checkpoints.addCheckpoint();
@@ -315,7 +326,7 @@ export interface Checkpoints {
    * This example creates a Store, adds a Checkpoints object, and then gets the
    * Ids of the checkpoints as it sets them and moves around the stack.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -354,7 +365,7 @@ export interface Checkpoints {
    * This example creates a Store, adds a Checkpoints object, and sets a
    * checkpoint with a label, before retrieving it again.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -370,7 +381,7 @@ export interface Checkpoints {
    * checkpoint without a label, setting it subsequently. A non-existent
    * checkpoint return an `undefined` label.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -405,7 +416,7 @@ export interface Checkpoints {
    * This example creates a Store, a Checkpoints object, and then registers a
    * listener that responds to any changes to the checkpoints.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -463,7 +474,7 @@ export interface Checkpoints {
    * listener that responds to any changes to a specific checkpoint label,
    * including when the checkpoint no longer exists.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -516,7 +527,7 @@ export interface Checkpoints {
    * This example creates a Store, a Checkpoints object, registers a listener,
    * and then removes it.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -554,7 +565,7 @@ export interface Checkpoints {
    * This example creates a Store, a Checkpoints object, makes a change and then
    * goes backward to the state of the Store before the change.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -572,6 +583,7 @@ export interface Checkpoints {
    * console.log(checkpoints.getCheckpointIds());
    * // -> [[], '0', ['1']]
    * ```
+   * @category Movement
    */
   goBackward(): Checkpoints;
 
@@ -592,7 +604,7 @@ export interface Checkpoints {
    * goes backward to the state of the Store before the change. It then goes
    * forward again to restore the state with the changes.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -622,7 +634,7 @@ export interface Checkpoints {
    * change, the redo stack disappears, and then the attempt to forward again
    * has no effect.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -651,6 +663,7 @@ export interface Checkpoints {
    * // -> [['0'], undefined, []]
    * // The original change cannot be redone.
    * ```
+   * @category Movement
    */
   goForward(): Checkpoints;
 
@@ -668,7 +681,7 @@ export interface Checkpoints {
    * then goes forward again one change, also using the goTo method. Finally it
    * tries to go to a checkpoint that does not exist.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -700,6 +713,7 @@ export interface Checkpoints {
    * console.log(checkpoints.getCheckpointIds());
    * // -> [['0'], '1', ['2']]
    * ```
+   * @category Movement
    */
   goTo(checkpointId: Id): Checkpoints;
 
@@ -724,7 +738,7 @@ export interface Checkpoints {
    * This example creates a Store, a Checkpoints object, adds a listener, makes
    * a change and then clears the checkpoints.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -773,7 +787,7 @@ export interface Checkpoints {
    * CellListener with the underlying Store), and then destroys it again,
    * removing the listener.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -807,7 +821,7 @@ export interface Checkpoints {
    * @example
    * This example gets the listener statistics of a Checkpoints object.
    *
-   * ```tsx
+   * ```js
    * const store = createStore();
    * const checkpoints = createCheckpoints(store);
    * checkpoints.addCheckpointIdsListener(() => {
@@ -840,7 +854,7 @@ export interface Checkpoints {
  * @example
  * This example creates a Checkpoints object.
  *
- * ```tsx
+ * ```js
  * const store = createStore();
  * const checkpoints = createCheckpoints(store);
  * console.log(checkpoints.getCheckpointIds());
@@ -850,12 +864,13 @@ export interface Checkpoints {
  * This example creates a Checkpoints object, and calls the method a second
  * time for the same Store to return the same object.
  *
- * ```tsx
+ * ```js
  * const store = createStore();
  * const checkpoints1 = createCheckpoints(store);
  * const checkpoints2 = createCheckpoints(store);
  * console.log(checkpoints1 === checkpoints2);
  * // -> true
  * ```
+ * @category Creation
  */
 export function createCheckpoints(store: Store): Checkpoints;

package/lib/debug/checkpoints.d.ts

@@ -43,6 +43,7 @@ export type CheckpointIds = [Ids, Id | undefined, Ids];
  * When called, a CheckpointIdsListener is given a reference to the Checkpoints
  * object.
  *
+ * @param checkpoints A reference to the Checkpoints object that changed.
  * @category Listener
  */
 export type CheckpointIdsListener = (checkpoints: Checkpoints) => void;
@@ -57,6 +58,8 @@ export type CheckpointIdsListener = (checkpoints: Checkpoints) => void;
  * When called, a CheckpointListener is given a reference to the Checkpoints
  * object, and the Id of the checkpoint whose label changed.
  *
+ * @param checkpoints A reference to the Checkpoints object that changed.
+ * @param checkpointId The Id of the checkpoint that changed.
  * @category Listener
  */
 export type CheckpointListener = (
@@ -75,7 +78,14 @@ export type CheckpointListener = (
  * @category Development
  */
 export type CheckpointsListenerStats = {
+  /**
+   * The number of CheckpointIdsListeners registered with the Checkpoints
+   * object.
+   */
   checkpointIds?: number;
+  /**
+   * The number of CheckpointListeners registered with the Checkpoints object.
+   */
   checkpoint?: number;
 };
 
@@ -101,7 +111,7 @@ export type CheckpointsListenerStats = {
  * to adding a checkpoint, getting the list of available checkpoints, and then
  * registering and removing a listener for them.
  *
- * ```tsx
+ * ```js
  * const store = createStore().setTables({pets: {fido: {sold: false}}});
  *
  * const checkpoints = createCheckpoints(store);
@@ -132,6 +142,7 @@ export type CheckpointsListenerStats = {
  * checkpoints.delListener(listenerId);
  * checkpoints.destroy();
  * ```
+ * @category Checkpoints
  */
 export interface Checkpoints {
   /**
@@ -151,7 +162,7 @@ export interface Checkpoints {
    * of the Checkpoints object dramatically and then creates more than that
    * number of checkpoints to demonstrate the oldest being pruned.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {views: 0}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -196,7 +207,7 @@ export interface Checkpoints {
    * This example creates a Store, adds a Checkpoints object, and adds two
    * checkpoints, one with a label.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -245,7 +256,7 @@ export interface Checkpoints {
    * This example creates a Store, adds a Checkpoints object, and sets two
    * checkpoints, one with a label, which are both then re-labelled.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -288,7 +299,7 @@ export interface Checkpoints {
    * and then gets its reference in order to update its data and set a
    * checkpoint.
    *
-   * ```tsx
+   * ```js
    * const checkpoints = createCheckpoints(createStore());
    * checkpoints.getStore().setCell('pets', 'fido', 'species', 'dog');
    * checkpoints.addCheckpoint();
@@ -315,7 +326,7 @@ export interface Checkpoints {
    * This example creates a Store, adds a Checkpoints object, and then gets the
    * Ids of the checkpoints as it sets them and moves around the stack.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -354,7 +365,7 @@ export interface Checkpoints {
    * This example creates a Store, adds a Checkpoints object, and sets a
    * checkpoint with a label, before retrieving it again.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -370,7 +381,7 @@ export interface Checkpoints {
    * checkpoint without a label, setting it subsequently. A non-existent
    * checkpoint return an `undefined` label.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -405,7 +416,7 @@ export interface Checkpoints {
    * This example creates a Store, a Checkpoints object, and then registers a
    * listener that responds to any changes to the checkpoints.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -463,7 +474,7 @@ export interface Checkpoints {
    * listener that responds to any changes to a specific checkpoint label,
    * including when the checkpoint no longer exists.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -516,7 +527,7 @@ export interface Checkpoints {
    * This example creates a Store, a Checkpoints object, registers a listener,
    * and then removes it.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -554,7 +565,7 @@ export interface Checkpoints {
    * This example creates a Store, a Checkpoints object, makes a change and then
    * goes backward to the state of the Store before the change.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -572,6 +583,7 @@ export interface Checkpoints {
    * console.log(checkpoints.getCheckpointIds());
    * // -> [[], '0', ['1']]
    * ```
+   * @category Movement
    */
   goBackward(): Checkpoints;
 
@@ -592,7 +604,7 @@ export interface Checkpoints {
    * goes backward to the state of the Store before the change. It then goes
    * forward again to restore the state with the changes.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -622,7 +634,7 @@ export interface Checkpoints {
    * change, the redo stack disappears, and then the attempt to forward again
    * has no effect.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -651,6 +663,7 @@ export interface Checkpoints {
    * // -> [['0'], undefined, []]
    * // The original change cannot be redone.
    * ```
+   * @category Movement
    */
   goForward(): Checkpoints;
 
@@ -668,7 +681,7 @@ export interface Checkpoints {
    * then goes forward again one change, also using the goTo method. Finally it
    * tries to go to a checkpoint that does not exist.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -700,6 +713,7 @@ export interface Checkpoints {
    * console.log(checkpoints.getCheckpointIds());
    * // -> [['0'], '1', ['2']]
    * ```
+   * @category Movement
    */
   goTo(checkpointId: Id): Checkpoints;
 
@@ -724,7 +738,7 @@ export interface Checkpoints {
    * This example creates a Store, a Checkpoints object, adds a listener, makes
    * a change and then clears the checkpoints.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -773,7 +787,7 @@ export interface Checkpoints {
    * CellListener with the underlying Store), and then destroys it again,
    * removing the listener.
    *
-   * ```tsx
+   * ```js
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -807,7 +821,7 @@ export interface Checkpoints {
    * @example
    * This example gets the listener statistics of a Checkpoints object.
    *
-   * ```tsx
+   * ```js
    * const store = createStore();
    * const checkpoints = createCheckpoints(store);
    * checkpoints.addCheckpointIdsListener(() => {
@@ -840,7 +854,7 @@ export interface Checkpoints {
  * @example
  * This example creates a Checkpoints object.
  *
- * ```tsx
+ * ```js
  * const store = createStore();
  * const checkpoints = createCheckpoints(store);
  * console.log(checkpoints.getCheckpointIds());
@@ -850,12 +864,13 @@ export interface Checkpoints {
  * This example creates a Checkpoints object, and calls the method a second
  * time for the same Store to return the same object.
  *
- * ```tsx
+ * ```js
  * const store = createStore();
  * const checkpoints1 = createCheckpoints(store);
  * const checkpoints2 = createCheckpoints(store);
  * console.log(checkpoints1 === checkpoints2);
  * // -> true
  * ```
+ * @category Creation
  */
 export function createCheckpoints(store: Store): Checkpoints;