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

package/lib/types/with-schemas/relationships.d.ts

@@ -239,6 +239,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'},
@@ -355,6 +356,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * `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'},
@@ -385,6 +387,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * `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'},
@@ -429,6 +432,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * ```
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -473,6 +477,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * ```
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -497,6 +502,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * 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');
@@ -529,6 +535,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * 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'},
@@ -567,6 +574,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * This example shows two simple Relationship existence checks.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const relationships = createRelationships(
    *   createStore(),
    * ).setRelationshipDefinition('petSpecies', 'pets', 'species', 'species');
@@ -599,6 +607,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * underlying local Table Id.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -638,6 +647,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * underlying remote Table Id.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const relationships = createRelationships(createStore());
    * relationships.setRelationshipDefinition(
    *   'petSpecies',
@@ -673,6 +683,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * 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'},
@@ -719,6 +730,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * 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'},
@@ -770,6 +782,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * 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'},
@@ -818,6 +831,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * definition.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -894,6 +908,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * 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'},
@@ -917,7 +932,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * const listenerId = relationships.addRemoteRowIdListener(
    *   'petSpecies',
    *   'cujo',
-   *   (relationships, relationshipId, localRowId) => {
+   *   (relationships) => {
    *     console.log('petSpecies relationship (from cujo) changed');
    *     console.log(relationships.getRemoteRowId('petSpecies', 'cujo'));
    *   },
@@ -936,6 +951,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * 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'},
@@ -1035,6 +1051,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * objects.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -1058,7 +1075,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * const listenerId = relationships.addLocalRowIdsListener(
    *   'petSpecies',
    *   'dog',
-   *   (relationships, relationshipId, remoteRowId) => {
+   *   (relationships) => {
    *     console.log('petSpecies relationship (to dog) changed');
    *     console.log(relationships.getLocalRowIds('petSpecies', 'dog'));
    *   },
@@ -1076,6 +1093,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * objects.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog', color: 'brown'},
@@ -1171,6 +1189,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * objects.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore().setTable('pets', {
    *   fido: {species: 'dog', next: 'felix'},
    *   felix: {species: 'cat', next: 'cujo'},
@@ -1188,7 +1207,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * const listenerId = relationships.addLinkedRowIdsListener(
    *   'petSequence',
    *   'fido',
-   *   (relationships, relationshipId, firstRowId) => {
+   *   (relationships) => {
    *     console.log('petSequence linked list (from fido) changed');
    *     console.log(relationships.getLinkedRowIds('petSequence', 'fido'));
    *   },
@@ -1229,6 +1248,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * and then removes it.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -1252,7 +1272,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * const listenerId = relationships.addLocalRowIdsListener(
    *   'petSpecies',
    *   'dog',
-   *   (relationships, relationshipId, remoteRowId) => {
+   *   () => {
    *     console.log('petSpecies relationship (to dog) changed');
    *   },
    * );
@@ -1282,6 +1302,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * and then destroys it again, removing the listener.
    *
    * ```js
+   * import {createRelationships, createStore} from 'tinybase';
    * const store = createStore()
    *   .setTable('pets', {
    *     fido: {species: 'dog'},
@@ -1331,6 +1352,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
    * 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, () => {
@@ -1370,6 +1392,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
  * This example creates a Relationships object.
  *
  * ```js
+ * import {createRelationships, createStore} from 'tinybase';
  * const store = createStore();
  * const relationships = createRelationships(store);
  * console.log(relationships.getRelationshipIds());
@@ -1380,6 +1403,7 @@ export interface Relationships<in out Schemas extends OptionalSchemas> {
  * 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);