tinybase 5.0.0-beta.17 → 5.0.0-beta.18

package/lib/types/checkpoints.d.ts

@@ -120,6 +120,8 @@ export type CheckpointsListenerStats = {
  * registering and removing a listener for them.
  *
  * ```js
+ * import {createCheckpoints, createStore} from 'tinybase';
+ *
  * const store = createStore()
  *   .setTables({pets: {fido: {sold: false}}})
  *   .setValue('open', true);
@@ -161,7 +163,6 @@ export type CheckpointsListenerStats = {
  * // Previous redo of checkpoints '1' and '2' are now not possible.
  *
  * checkpoints.delListener(listenerId);
- * checkpoints.destroy();
  * ```
  * @see Relationships And Checkpoints guides
  * @see Todo App demos
@@ -187,6 +188,8 @@ export interface Checkpoints {
    * number of checkpoints to demonstrate the oldest being pruned.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {views: 0}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -231,6 +234,8 @@ export interface Checkpoints {
    * checkpoints, one with a label.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -279,6 +284,8 @@ export interface Checkpoints {
    * checkpoints, one with a label, which are both then re-labelled.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -321,6 +328,8 @@ export interface Checkpoints {
    * checkpoint.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const checkpoints = createCheckpoints(createStore());
    * checkpoints.getStore().setCell('pets', 'fido', 'species', 'dog');
    * checkpoints.addCheckpoint();
@@ -347,6 +356,8 @@ export interface Checkpoints {
    * Ids of the checkpoints as it sets them and moves around the stack.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -384,6 +395,8 @@ export interface Checkpoints {
    * This example iterates over each Checkpoint in a Checkpoints object.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    * const checkpoints = createCheckpoints(store);
    * store.setCell('pets', 'fido', 'sold', true);
@@ -409,6 +422,8 @@ export interface Checkpoints {
    * This example shows two simple Checkpoint existence checks.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    * const checkpoints = createCheckpoints(store);
    * console.log(checkpoints.hasCheckpoint('0'));
@@ -435,6 +450,8 @@ export interface Checkpoints {
    * checkpoint with a label, before retrieving it again.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -451,6 +468,8 @@ export interface Checkpoints {
    * checkpoint return an `undefined` label.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -485,6 +504,8 @@ export interface Checkpoints {
    * listener that responds to any changes to the checkpoints.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -513,7 +534,6 @@ export interface Checkpoints {
    * // -> [['0'], '1', []]
    *
    * checkpoints.delListener(listenerId);
-   * checkpoints.destroy();
    * ```
    * @category Listener
    */
@@ -542,6 +562,8 @@ export interface Checkpoints {
    * including when the checkpoint no longer exists.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -572,7 +594,6 @@ export interface Checkpoints {
    * // The checkpoint no longer exists.
    *
    * checkpoints.delListener(listenerId);
-   * checkpoints.destroy();
    * ```
    * @category Listener
    */
@@ -594,6 +615,8 @@ export interface Checkpoints {
    * and then removes it.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -631,6 +654,8 @@ export interface Checkpoints {
    * goes backward to the state of the Store before the change.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -669,6 +694,8 @@ export interface Checkpoints {
    * forward again to restore the state with the changes.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -699,6 +726,8 @@ export interface Checkpoints {
    * has no effect.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -745,6 +774,8 @@ export interface Checkpoints {
    * tries to go to a checkpoint that does not exist.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -799,6 +830,8 @@ export interface Checkpoints {
    * a change and then clears the checkpoints.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -830,6 +863,8 @@ export interface Checkpoints {
    * // -> {pets: {fido: {sold: true, color: 'brown'}}}
    * console.log(checkpoints.getCheckpointIds());
    * // -> [[], '0', []]
+   *
+   * checkpoints.delListener(listenerId);
    * ```
    * @category Lifecycle
    */
@@ -852,6 +887,8 @@ export interface Checkpoints {
    * a change and then clears the forward checkpoints.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -883,6 +920,8 @@ export interface Checkpoints {
    *
    * console.log(checkpoints.getCheckpointIds());
    * // -> [['0'], '1', []]
+   *
+   * checkpoints.delListener(listenerId);
    * ```
    * @category Lifecycle
    * @since v4.5.3
@@ -901,6 +940,8 @@ export interface Checkpoints {
    * removing the listener.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore().setTables({pets: {fido: {sold: false}}});
    *
    * const checkpoints = createCheckpoints(store);
@@ -934,6 +975,8 @@ export interface Checkpoints {
    * This example gets the listener statistics of a Checkpoints object.
    *
    * ```js
+   * import {createCheckpoints, createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const checkpoints = createCheckpoints(store);
    * checkpoints.addCheckpointIdsListener(() => {
@@ -965,6 +1008,8 @@ export interface Checkpoints {
  * This example creates a Checkpoints object.
  *
  * ```js
+ * import {createCheckpoints, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const checkpoints = createCheckpoints(store);
  * console.log(checkpoints.getCheckpointIds());
@@ -975,6 +1020,8 @@ export interface Checkpoints {
  * time for the same Store to return the same object.
  *
  * ```js
+ * import {createCheckpoints, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const checkpoints1 = createCheckpoints(store);
  * const checkpoints2 = createCheckpoints(store);

package/lib/types/common.d.ts

@@ -69,6 +69,8 @@ export type SortKey = string | number | boolean;
  * This example creates an Indexes object.
  *
  * ```js
+ * import {createIndexes, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const indexes = createIndexes(store);
  * console.log(indexes.getIndexIds());
@@ -80,6 +82,8 @@ export type SortKey = string | number | boolean;
  * Ids within them) are alphabetically sorted using the defaultSorter function.
  *
  * ```js
+ * import {createIndexes, createStore, defaultSorter} from 'tinybase';
+ *
  * const store = createStore().setTable('pets', {
  *   fido: {species: 'dog'},
  *   felix: {species: 'cat'},

package/lib/types/indexes.d.ts

@@ -165,6 +165,8 @@ export type IndexesListenerStats = {
  * and removing a listener for it.
  *
  * ```js
+ * import {createIndexes, createStore} from 'tinybase';
+ *
  * const store = createStore().setTable('pets', {
  *   fido: {species: 'dog'},
  *   felix: {species: 'cat'},
@@ -267,6 +269,8 @@ export interface Indexes {
    * simple Index based on the values in the `species` Cell.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -286,6 +290,8 @@ export interface Indexes {
    * Index based on the first letter of the pets' names.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -305,6 +311,8 @@ export interface Indexes {
    * Index based on each of the letters present in the pets' names.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -329,6 +337,8 @@ export interface Indexes {
    * Ids within them) are alphabetically sorted.
    *
    * ```js
+   * import {createIndexes, createStore, defaultSorter} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -370,6 +380,8 @@ export interface Indexes {
    * Index, and then removes it.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -398,6 +410,8 @@ export interface Indexes {
    * then gets its reference in order to update its data.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const indexes = createIndexes(createStore());
    * indexes.setIndexDefinition('bySpecies', 'pets', 'species');
    * indexes.getStore().setCell('pets', 'fido', 'species', 'dog');
@@ -417,6 +431,8 @@ export interface Indexes {
    * the Ids of the definitions.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const indexes = createIndexes(createStore())
    *   .setIndexDefinition('bySpecies', 'pets', 'species')
    *   .setIndexDefinition('byColor', 'pets', 'color');
@@ -443,6 +459,8 @@ export interface Indexes {
    * Slice Id within them.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -481,6 +499,8 @@ export interface Indexes {
    * This example iterates over each Row in a Slice, and lists its Id.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -512,6 +532,8 @@ export interface Indexes {
    * This example shows two simple Index existence checks.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const indexes = createIndexes(createStore());
    * indexes.setIndexDefinition('bySpecies', 'pets', 'species');
    * console.log(indexes.hasIndex('bySpecies'));
@@ -533,6 +555,8 @@ export interface Indexes {
    * This example shows two simple Index existence checks.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -561,6 +585,8 @@ export interface Indexes {
    * queries it (and a non-existent definition) to get the underlying Table Id.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const indexes = createIndexes(createStore());
    * indexes.setIndexDefinition('bySpecies', 'pets', 'species');
    *
@@ -586,6 +612,8 @@ export interface Indexes {
    * the Index (and also the Slice Ids in an Index that has not been defined).
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -619,6 +647,8 @@ export interface Indexes {
    * (and also the Row Ids in Slices that do not exist).
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -660,6 +690,8 @@ export interface Indexes {
    * listener that responds to any changes to a specific Index.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -669,13 +701,10 @@ export interface Indexes {
    * const indexes = createIndexes(store);
    * indexes.setIndexDefinition('bySpecies', 'pets', 'species');
    *
-   * const listenerId = indexes.addSliceIdsListener(
-   *   'bySpecies',
-   *   (indexes, indexId) => {
-   *     console.log('Slice Ids for bySpecies index changed');
-   *     console.log(indexes.getSliceIds('bySpecies'));
-   *   },
-   * );
+   * const listenerId = indexes.addSliceIdsListener('bySpecies', (indexes) => {
+   *   console.log('Slice Ids for bySpecies index changed');
+   *   console.log(indexes.getSliceIds('bySpecies'));
+   * });
    *
    * store.setRow('pets', 'lowly', {species: 'worm'});
    * // -> 'Slice Ids for bySpecies index changed'
@@ -688,6 +717,8 @@ export interface Indexes {
    * listener that responds to any changes to any Index.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -733,6 +764,8 @@ export interface Indexes {
    * definition.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -782,6 +815,8 @@ export interface Indexes {
    * listener that responds to any changes to a specific Slice.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -794,7 +829,7 @@ export interface Indexes {
    * const listenerId = indexes.addSliceRowIdsListener(
    *   'bySpecies',
    *   'dog',
-   *   (indexes, indexId, sliceId) => {
+   *   (indexes) => {
    *     console.log('Row Ids for dog slice in bySpecies index changed');
    *     console.log(indexes.getSliceRowIds('bySpecies', 'dog'));
    *   },
@@ -811,6 +846,8 @@ export interface Indexes {
    * listener that responds to any changes to any Slice.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', color: 'brown'},
    *   felix: {species: 'cat', color: 'black'},
@@ -862,6 +899,8 @@ export interface Indexes {
    * then removes it.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -871,12 +910,9 @@ export interface Indexes {
    * const indexes = createIndexes(store);
    * indexes.setIndexDefinition('bySpecies', 'pets', 'species');
    *
-   * const listenerId = indexes.addSliceIdsListener(
-   *   'bySpecies',
-   *   (indexes, indexId) => {
-   *     console.log('Slice Ids for bySpecies index changed');
-   *   },
-   * );
+   * const listenerId = indexes.addSliceIdsListener('bySpecies', () => {
+   *   console.log('Slice Ids for bySpecies index changed');
+   * });
    *
    * store.setRow('pets', 'lowly', {species: 'worm'});
    * // -> 'Slice Ids for bySpecies index changed'
@@ -903,6 +939,8 @@ export interface Indexes {
    * and then destroys it again, removing the listener.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog'},
    *   felix: {species: 'cat'},
@@ -941,6 +979,8 @@ export interface Indexes {
    * This example gets the listener statistics of an Indexes object.
    *
    * ```js
+   * import {createIndexes, createStore} from 'tinybase';
+   *
    * const store = createStore();
    * const indexes = createIndexes(store);
    * indexes.addSliceIdsListener(null, () => {
@@ -972,6 +1012,8 @@ export interface Indexes {
  * This example creates an Indexes object.
  *
  * ```js
+ * import {createIndexes, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const indexes = createIndexes(store);
  * console.log(indexes.getIndexIds());
@@ -982,6 +1024,8 @@ export interface Indexes {
  * for the same Store to return the same object.
  *
  * ```js
+ * import {createIndexes, createStore} from 'tinybase';
+ *
  * const store = createStore();
  * const indexes1 = createIndexes(store);
  * const indexes2 = createIndexes(store);

package/lib/types/mergeable-store.d.ts

@@ -199,6 +199,15 @@ export interface MergeableStore extends Store {
    * @category Setter
    */
   merge(mergeableStore: MergeableStore): MergeableStore;
+
+  /**
+   * The isMergeable methods lets you know if the Store is mergeable.
+   *
+   * This will always be false for a Store, and true for a MergeableStore.
+   * @category Information
+   * @since v5.0.0
+   */
+  isMergeable: () => boolean;
 }
 
 /**