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

package/lib/types/relationships.d.ts

@@ -185,6 +185,7 @@ export type RelationshipsListenerStats = {
  * getting their contents, and then registering and removing listeners for them.
  *
  * ```js
+ * import {createRelationships, createStore} from 'tinybase';
  * const store = createStore()
  *   .setTable('pets', {
  *     fido: {species: 'dog', next: 'felix'},
@@ -291,6 +292,7 @@ export interface Relationships {
    * `pets` Table that relates a Row to another in the `species` Table.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -321,6 +323,7 @@ export interface Relationships {
    * `pets` Table that relates a Row to another in the same Table.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -357,6 +360,7 @@ export interface Relationships {
    * simple Relationship, and then removes it.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -395,6 +399,7 @@ export interface Relationships {
    * and then gets its reference in order to update its data.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -419,6 +424,7 @@ export interface Relationships {
    * gets the Ids of the definitions.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const relationships = createRelationships(createStore())
    *   .setRelationshipDefinition('petSpecies', 'pets', 'species', 'species')
    *   .setRelationshipDefinition('petSequence', 'pets', 'pets', 'next');
@@ -445,6 +451,7 @@ export interface Relationships {
    * lists each Row Id within them.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -481,6 +488,7 @@ export interface Relationships {
    * This example shows two simple Relationship existence checks.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const relationships = createRelationships(
    *   createStore(),
    * ).setRelationshipDefinition('petSpecies', 'pets', 'species', 'species');
@@ -507,6 +515,7 @@ export interface Relationships {
    * underlying local Table Id.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -538,6 +547,7 @@ export interface Relationships {
    * underlying remote Table Id.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -571,6 +581,7 @@ export interface Relationships {
    * not exist, and for a Relationship that has not been defined).
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -617,6 +628,7 @@ export interface Relationships {
    * not exist, and for a Relationship that has not been defined).
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -668,6 +680,7 @@ export interface Relationships {
    * that does not exist, and for a Relationship that has not been defined).
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -710,6 +723,7 @@ export interface Relationships {
    * definition.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -776,6 +790,7 @@ export interface Relationships {
    * listener that responds to any changes to a specific local Row's remote Row.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -799,7 +814,7 @@ export interface Relationships {
    * const listenerId = relationships.addRemoteRowIdListener(
    *   'petSpecies',
    *   'cujo',
-   *   (relationships, relationshipId, localRowId) => {
+   *   (relationships) => {
    *     console.log('petSpecies relationship (from cujo) changed');
    *     console.log(relationships.getRemoteRowId('petSpecies', 'cujo'));
    *   },
@@ -818,6 +833,7 @@ export interface Relationships {
    * method to resolve the remote Row as a whole.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog', color: 'brown'},
@@ -907,6 +923,7 @@ export interface Relationships {
    * objects.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -930,7 +947,7 @@ export interface Relationships {
    * const listenerId = relationships.addLocalRowIdsListener(
    *   'petSpecies',
    *   'dog',
-   *   (relationships, relationshipId, remoteRowId) => {
+   *   (relationships) => {
    *     console.log('petSpecies relationship (to dog) changed');
    *     console.log(relationships.getLocalRowIds('petSpecies', 'dog'));
    *   },
@@ -948,6 +965,7 @@ export interface Relationships {
    * objects.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog', color: 'brown'},
@@ -1033,6 +1051,7 @@ export interface Relationships {
    * objects.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -1050,7 +1069,7 @@ export interface Relationships {
    * const listenerId = relationships.addLinkedRowIdsListener(
    *   'petSequence',
    *   'fido',
-   *   (relationships, relationshipId, firstRowId) => {
+   *   (relationships) => {
    *     console.log('petSequence linked list (from fido) changed');
    *     console.log(relationships.getLinkedRowIds('petSequence', 'fido'));
    *   },
@@ -1085,6 +1104,7 @@ export interface Relationships {
    * and then removes it.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -1108,7 +1128,7 @@ export interface Relationships {
    * const listenerId = relationships.addLocalRowIdsListener(
    *   'petSpecies',
    *   'dog',
-   *   (relationships, relationshipId, remoteRowId) => {
+   *   () => {
    *     console.log('petSpecies relationship (to dog) changed');
    *   },
    * );
@@ -1138,6 +1158,7 @@ export interface Relationships {
    * and then destroys it again, removing the listener.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -1187,6 +1208,7 @@ export interface Relationships {
    * This example gets the listener statistics of a Relationships object.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore();
    * const relationships = createRelationships(store);
    * relationships.addRemoteRowIdListener(null, null, () => {
@@ -1221,6 +1243,7 @@ export interface Relationships {
  * This example creates a Relationships object.
  *
  * ```js
+ * import {createRelationships, createStore} from 'tinybase';
  * const store = createStore();
  * const relationships = createRelationships(store);
  * console.log(relationships.getRelationshipIds());
@@ -1231,6 +1254,7 @@ export interface Relationships {
  * time for the same Store to return the same object.
  *
  * ```js
+ * import {createRelationships, createStore} from 'tinybase';
  * const store = createStore();
  * const relationships1 = createRelationships(store);
  * const relationships2 = createRelationships(store);