tinybase 5.0.0-beta.26 → 5.0.0-beta.28

package/@types/synchronizers/synchronizer-broadcast-channel/index.d.ts

@@ -0,0 +1,114 @@
+/**
+ * The synchronizer-broadcast-channel module of the TinyBase project lets you
+ * synchronize MergeableStore data to and from other MergeableStore instances
+ * via a browser's BroadcastChannel API.
+ * @see Synchronization guide
+ * @packageDocumentation
+ * @module synchronizer-broadcast-channel
+ * @since v5.0.0
+ */
+
+import type {MergeableStore} from '../../mergeable-store/index.d.ts';
+import type {Synchronizer} from '../index.d.ts';
+
+/**
+ * The BroadcastChannelSynchronizer interface represents a Synchronizer that
+ * lets you synchronize MergeableStore data to and from other MergeableStore
+ * instances via a browser's BroadcastChannel API.
+ *
+ * You should use the createBroadcastChannelSynchronizer function to create a
+ * BroadcastChannelSynchronizer object.
+ *
+ * It is a minor extension to the Synchronizer interface and simply provides an
+ * extra getChannelName method for accessing the name of the channel being used.
+ * @category Synchronizer
+ * @since v5.0.0
+ */
+export interface BroadcastChannelSynchronizer extends Synchronizer {
+  /**
+   * The getChannelName method returns the name of the channel being used for
+   * synchronization.
+   * @returns The channel name.
+   * @example
+   * This example creates a BroadcastChannelSynchronizer object for a
+   * newly-created MergeableStore and then gets the channel name back out again.
+   *
+   * ```js
+   * import {createBroadcastChannelSynchronizer} from 'tinybase/synchronizers/synchronizer-broadcast-channel';
+   * import {createMergeableStore} from 'tinybase';
+   *
+   * const store = createMergeableStore();
+   * const synchronizer = await createBroadcastChannelSynchronizer(
+   *   store,
+   *   'channelA',
+   * );
+   *
+   * console.log(synchronizer.getChannelName());
+   * // -> 'channelA'
+   *
+   * synchronizer.destroy();
+   * ```
+   * @category Getter
+   * @since v5.0.0
+   */
+  getChannelName(): string;
+}
+
+/**
+ * The createBroadcastChannelSynchronizer function creates a
+ * BroadcastChannelSynchronizer object that can synchronize MergeableStore data
+ * to and from other MergeableStore instances via a browser's BroadcastChannel
+ * API.
+ *
+ * As well as providing a reference to the MergeableStore to persist, you must
+ * provide a channel name, used by all the browser tabs, workers, or contexts
+ * that need to synchronize together.
+ * @param store The MergeableStore to synchronize.
+ * @param channelName The name of the channel to use.
+ * @param onIgnoredError An optional handler for the errors that the
+ * Synchronizer would otherwise ignore when trying to synchronize data. This is
+ * suitable for debugging synchronization issues in a development environment.
+ * @returns A reference to the new BroadcastChannelSynchronizer object.
+ * @example
+ * This example creates two BroadcastChannelSynchronizer objects to synchronize
+ * one MergeableStore to another.
+ *
+ * ```js
+ * import {createBroadcastChannelSynchronizer} from 'tinybase/synchronizers/synchronizer-broadcast-channel';
+ * import {createMergeableStore} from 'tinybase';
+ *
+ * const store1 = createMergeableStore();
+ * const store2 = createMergeableStore();
+ *
+ * const synchronizer1 = createBroadcastChannelSynchronizer(
+ *   store1,
+ *   'channelA',
+ * );
+ * const synchronizer2 = createBroadcastChannelSynchronizer(
+ *   store2,
+ *   'channelA',
+ * );
+ *
+ * await synchronizer1.startSync();
+ * await synchronizer2.startSync();
+ *
+ * store1.setTables({pets: {fido: {species: 'dog'}}});
+ * store2.setTables({pets: {felix: {species: 'cat'}}});
+ *
+ * // ...
+ * console.log(store1.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ * console.log(store2.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * synchronizer1.destroy();
+ * synchronizer2.destroy();
+ * ```
+ * @category Creation
+ * @since v5.0.0
+ */
+export function createBroadcastChannelSynchronizer(
+  store: MergeableStore,
+  channelName: string,
+  onIgnoredError?: (error: any) => void,
+): BroadcastChannelSynchronizer;

package/@types/synchronizers/synchronizer-broadcast-channel/with-schemas/index.d.cts

@@ -0,0 +1,128 @@
+/**
+ * The synchronizer-broadcast-channel module of the TinyBase project lets you
+ * synchronize MergeableStore data to and from other MergeableStore instances
+ * via a browser's BroadcastChannel API.
+ * @see Synchronization guide
+ * @packageDocumentation
+ * @module synchronizer-broadcast-channel
+ * @since v5.0.0
+ */
+
+import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.cts';
+import type {OptionalSchemas} from '../../../store/with-schemas/index.d.cts';
+import type {Synchronizer} from '../../with-schemas/index.d.cts';
+
+/**
+ * The BroadcastChannelSynchronizer interface represents a Synchronizer that
+ * lets you synchronize MergeableStore data to and from other MergeableStore
+ * instances via a browser's BroadcastChannel API.
+ *
+ * You should use the createBroadcastChannelSynchronizer function to create a
+ * BroadcastChannelSynchronizer object.
+ *
+ * It is a minor extension to the Synchronizer interface and simply provides an
+ * extra getChannelName method for accessing the name of the channel being used.
+ * @category Synchronizer
+ * @since v5.0.0
+ */
+export interface BroadcastChannelSynchronizer<Schemas extends OptionalSchemas>
+  extends Synchronizer<Schemas> {
+  /**
+   * The getChannelName method returns the name of the channel being used for
+   * synchronization.
+   * @returns The channel name.
+   * @example
+   * This example creates a BroadcastChannelSynchronizer object for a
+   * newly-created MergeableStore and then gets the channel name back out again.
+   *
+   * ```js
+   * import {createBroadcastChannelSynchronizer} from 'tinybase/synchronizers/synchronizer-broadcast-channel';
+   * import {createMergeableStore} from 'tinybase';
+   *
+   * const store = createMergeableStore();
+   * const synchronizer = await createBroadcastChannelSynchronizer(
+   *   store,
+   *   'channelA',
+   * );
+   *
+   * console.log(synchronizer.getChannelName());
+   * // -> 'channelA'
+   *
+   * synchronizer.destroy();
+   * ```
+   * @category Getter
+   * @since v5.0.0
+   */
+  getChannelName(): string;
+}
+
+/**
+ * The createBroadcastChannelSynchronizer function creates a
+ * BroadcastChannelSynchronizer object that can synchronize MergeableStore data
+ * to and from other MergeableStore instances via a browser's BroadcastChannel
+ * API.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createBroadcastChannelSynchronizer(
+ *   store: MergeableStore,
+ *   channelName: string,
+ *   onIgnoredError?: (error: any) => void,
+ * ): BroadcastChannelSynchronizer;
+ * ```
+ *
+ * As well as providing a reference to the MergeableStore to persist, you must
+ * provide a channel name, used by all the browser tabs, workers, or contexts
+ * that need to synchronize together.
+ * @param store The MergeableStore to synchronize.
+ * @param channelName The name of the channel to use.
+ * @param onIgnoredError An optional handler for the errors that the
+ * Synchronizer would otherwise ignore when trying to synchronize data. This is
+ * suitable for debugging synchronization issues in a development environment.
+ * @returns A reference to the new BroadcastChannelSynchronizer object.
+ * @example
+ * This example creates two BroadcastChannelSynchronizer objects to synchronize
+ * one MergeableStore to another.
+ *
+ * ```js
+ * import {createBroadcastChannelSynchronizer} from 'tinybase/synchronizers/synchronizer-broadcast-channel';
+ * import {createMergeableStore} from 'tinybase';
+ *
+ * const store1 = createMergeableStore();
+ * const store2 = createMergeableStore();
+ *
+ * const synchronizer1 = createBroadcastChannelSynchronizer(
+ *   store1,
+ *   'channelA',
+ * );
+ * const synchronizer2 = createBroadcastChannelSynchronizer(
+ *   store2,
+ *   'channelA',
+ * );
+ *
+ * await synchronizer1.startSync();
+ * await synchronizer2.startSync();
+ *
+ * store1.setTables({pets: {fido: {species: 'dog'}}});
+ * store2.setTables({pets: {felix: {species: 'cat'}}});
+ *
+ * // ...
+ * console.log(store1.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ * console.log(store2.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * synchronizer1.destroy();
+ * synchronizer2.destroy();
+ * ```
+ * @category Creation
+ * @since v5.0.0
+ */
+export function createBroadcastChannelSynchronizer<
+  Schemas extends OptionalSchemas,
+>(
+  store: MergeableStore<Schemas>,
+  channelName: string,
+  onIgnoredError?: (error: any) => void,
+): BroadcastChannelSynchronizer<Schemas>;

package/@types/synchronizers/synchronizer-broadcast-channel/with-schemas/index.d.ts

@@ -0,0 +1,128 @@
+/**
+ * The synchronizer-broadcast-channel module of the TinyBase project lets you
+ * synchronize MergeableStore data to and from other MergeableStore instances
+ * via a browser's BroadcastChannel API.
+ * @see Synchronization guide
+ * @packageDocumentation
+ * @module synchronizer-broadcast-channel
+ * @since v5.0.0
+ */
+
+import type {MergeableStore} from '../../../mergeable-store/with-schemas/index.d.ts';
+import type {OptionalSchemas} from '../../../store/with-schemas/index.d.ts';
+import type {Synchronizer} from '../../with-schemas/index.d.ts';
+
+/**
+ * The BroadcastChannelSynchronizer interface represents a Synchronizer that
+ * lets you synchronize MergeableStore data to and from other MergeableStore
+ * instances via a browser's BroadcastChannel API.
+ *
+ * You should use the createBroadcastChannelSynchronizer function to create a
+ * BroadcastChannelSynchronizer object.
+ *
+ * It is a minor extension to the Synchronizer interface and simply provides an
+ * extra getChannelName method for accessing the name of the channel being used.
+ * @category Synchronizer
+ * @since v5.0.0
+ */
+export interface BroadcastChannelSynchronizer<Schemas extends OptionalSchemas>
+  extends Synchronizer<Schemas> {
+  /**
+   * The getChannelName method returns the name of the channel being used for
+   * synchronization.
+   * @returns The channel name.
+   * @example
+   * This example creates a BroadcastChannelSynchronizer object for a
+   * newly-created MergeableStore and then gets the channel name back out again.
+   *
+   * ```js
+   * import {createBroadcastChannelSynchronizer} from 'tinybase/synchronizers/synchronizer-broadcast-channel';
+   * import {createMergeableStore} from 'tinybase';
+   *
+   * const store = createMergeableStore();
+   * const synchronizer = await createBroadcastChannelSynchronizer(
+   *   store,
+   *   'channelA',
+   * );
+   *
+   * console.log(synchronizer.getChannelName());
+   * // -> 'channelA'
+   *
+   * synchronizer.destroy();
+   * ```
+   * @category Getter
+   * @since v5.0.0
+   */
+  getChannelName(): string;
+}
+
+/**
+ * The createBroadcastChannelSynchronizer function creates a
+ * BroadcastChannelSynchronizer object that can synchronize MergeableStore data
+ * to and from other MergeableStore instances via a browser's BroadcastChannel
+ * API.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createBroadcastChannelSynchronizer(
+ *   store: MergeableStore,
+ *   channelName: string,
+ *   onIgnoredError?: (error: any) => void,
+ * ): BroadcastChannelSynchronizer;
+ * ```
+ *
+ * As well as providing a reference to the MergeableStore to persist, you must
+ * provide a channel name, used by all the browser tabs, workers, or contexts
+ * that need to synchronize together.
+ * @param store The MergeableStore to synchronize.
+ * @param channelName The name of the channel to use.
+ * @param onIgnoredError An optional handler for the errors that the
+ * Synchronizer would otherwise ignore when trying to synchronize data. This is
+ * suitable for debugging synchronization issues in a development environment.
+ * @returns A reference to the new BroadcastChannelSynchronizer object.
+ * @example
+ * This example creates two BroadcastChannelSynchronizer objects to synchronize
+ * one MergeableStore to another.
+ *
+ * ```js
+ * import {createBroadcastChannelSynchronizer} from 'tinybase/synchronizers/synchronizer-broadcast-channel';
+ * import {createMergeableStore} from 'tinybase';
+ *
+ * const store1 = createMergeableStore();
+ * const store2 = createMergeableStore();
+ *
+ * const synchronizer1 = createBroadcastChannelSynchronizer(
+ *   store1,
+ *   'channelA',
+ * );
+ * const synchronizer2 = createBroadcastChannelSynchronizer(
+ *   store2,
+ *   'channelA',
+ * );
+ *
+ * await synchronizer1.startSync();
+ * await synchronizer2.startSync();
+ *
+ * store1.setTables({pets: {fido: {species: 'dog'}}});
+ * store2.setTables({pets: {felix: {species: 'cat'}}});
+ *
+ * // ...
+ * console.log(store1.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ * console.log(store2.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * synchronizer1.destroy();
+ * synchronizer2.destroy();
+ * ```
+ * @category Creation
+ * @since v5.0.0
+ */
+export function createBroadcastChannelSynchronizer<
+  Schemas extends OptionalSchemas,
+>(
+  store: MergeableStore<Schemas>,
+  channelName: string,
+  onIgnoredError?: (error: any) => void,
+): BroadcastChannelSynchronizer<Schemas>;

package/@types/synchronizers/synchronizer-local/index.d.cts

@@ -2,7 +2,7 @@
  * The synchronizer-local module of the TinyBase project lets you synchronize
  * MergeableStore data to and from other MergeableStore instances on the same
  * local machine.
- * @see Synchronizing Data guide
+ * @see Synchronization guide
  * @packageDocumentation
  * @module synchronizer-local
  * @since v5.0.0
@@ -12,14 +12,73 @@ import type {MergeableStore} from '../../mergeable-store/index.d.cts';
 import type {Synchronizer} from '../index.d.cts';
 
 /**
- * The LocalSynchronizer interface.
+ * The LocalSynchronizer interface represents a Synchronizer that lets you
+ * synchronize MergeableStore data to and from other MergeableStore instances on
+ * the same local machine.
+ *
+ * You should use the createLocalSynchronizer function to create a
+ * LocalSynchronizer object.
+ *
+ * Having no specialized methods, it is a synonym for the Synchronizer
+ * interface. This is also something of a showcase Synchronizer, rather than
+ * something you would use in a production environment. If you _do_ need to
+ * synchronize two in-memory MergeableStore instances, you may prefer to use the
+ * merge function on either one of them instead of going to the effort of
+ * setting up this Synchronizer.
  * @category Synchronizer
+ * @since v5.0.0
  */
 export interface LocalSynchronizer extends Synchronizer {}
 
 /**
- * The createLocalSynchronizer function.
+ * The createLocalSynchronizer function creates a LocalSynchronizer object that
+ * can synchronize MergeableStore data to and from other MergeableStore
+ * instances on the same local machine.
+ *
+ * This is something of a showcase Synchronizer, rather than something you would
+ * use in a production environment. If you _do_ need to synchronize two
+ * in-memory MergeableStore instances, you may prefer to use the merge function
+ * on either one of them instead of going to the effort of setting up this
+ * Synchronizer.
+ *
+ * As well as providing a reference to the MergeableStore to persist, you can
+ * provide a handler for any otherwise ignored synchronization errors.
+ * @param store The MergeableStore to synchronize.
+ * @param onIgnoredError An optional handler for the errors that the
+ * Synchronizer would otherwise ignore when trying to synchronize data. This is
+ * suitable for debugging synchronization issues in a development environment.
+ * @returns A reference to the new LocalSynchronizer object.
+ * @example
+ * This example creates two LocalSynchronizer objects to synchronize one
+ * MergeableStore to another.
+ *
+ * ```js
+ * import {createLocalSynchronizer} from 'tinybase/synchronizers/synchronizer-local';
+ * import {createMergeableStore} from 'tinybase';
+ *
+ * const store1 = createMergeableStore();
+ * const store2 = createMergeableStore();
+ *
+ * const synchronizer1 = createLocalSynchronizer(store1);
+ * const synchronizer2 = createLocalSynchronizer(store2);
+ *
+ * await synchronizer1.startSync();
+ * await synchronizer2.startSync();
+ *
+ * store1.setTables({pets: {fido: {species: 'dog'}}});
+ * store2.setTables({pets: {felix: {species: 'cat'}}});
+ *
+ * // ...
+ * console.log(store1.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ * console.log(store2.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * synchronizer1.destroy();
+ * synchronizer2.destroy();
+ * ```
  * @category Creation
+ * @since v5.0.0
  */
 export function createLocalSynchronizer(
   store: MergeableStore,

package/@types/synchronizers/synchronizer-local/index.d.ts

@@ -2,7 +2,7 @@
  * The synchronizer-local module of the TinyBase project lets you synchronize
  * MergeableStore data to and from other MergeableStore instances on the same
  * local machine.
- * @see Synchronizing Data guide
+ * @see Synchronization guide
  * @packageDocumentation
  * @module synchronizer-local
  * @since v5.0.0
@@ -12,14 +12,73 @@ import type {MergeableStore} from '../../mergeable-store/index.d.ts';
 import type {Synchronizer} from '../index.d.ts';
 
 /**
- * The LocalSynchronizer interface.
+ * The LocalSynchronizer interface represents a Synchronizer that lets you
+ * synchronize MergeableStore data to and from other MergeableStore instances on
+ * the same local machine.
+ *
+ * You should use the createLocalSynchronizer function to create a
+ * LocalSynchronizer object.
+ *
+ * Having no specialized methods, it is a synonym for the Synchronizer
+ * interface. This is also something of a showcase Synchronizer, rather than
+ * something you would use in a production environment. If you _do_ need to
+ * synchronize two in-memory MergeableStore instances, you may prefer to use the
+ * merge function on either one of them instead of going to the effort of
+ * setting up this Synchronizer.
  * @category Synchronizer
+ * @since v5.0.0
  */
 export interface LocalSynchronizer extends Synchronizer {}
 
 /**
- * The createLocalSynchronizer function.
+ * The createLocalSynchronizer function creates a LocalSynchronizer object that
+ * can synchronize MergeableStore data to and from other MergeableStore
+ * instances on the same local machine.
+ *
+ * This is something of a showcase Synchronizer, rather than something you would
+ * use in a production environment. If you _do_ need to synchronize two
+ * in-memory MergeableStore instances, you may prefer to use the merge function
+ * on either one of them instead of going to the effort of setting up this
+ * Synchronizer.
+ *
+ * As well as providing a reference to the MergeableStore to persist, you can
+ * provide a handler for any otherwise ignored synchronization errors.
+ * @param store The MergeableStore to synchronize.
+ * @param onIgnoredError An optional handler for the errors that the
+ * Synchronizer would otherwise ignore when trying to synchronize data. This is
+ * suitable for debugging synchronization issues in a development environment.
+ * @returns A reference to the new LocalSynchronizer object.
+ * @example
+ * This example creates two LocalSynchronizer objects to synchronize one
+ * MergeableStore to another.
+ *
+ * ```js
+ * import {createLocalSynchronizer} from 'tinybase/synchronizers/synchronizer-local';
+ * import {createMergeableStore} from 'tinybase';
+ *
+ * const store1 = createMergeableStore();
+ * const store2 = createMergeableStore();
+ *
+ * const synchronizer1 = createLocalSynchronizer(store1);
+ * const synchronizer2 = createLocalSynchronizer(store2);
+ *
+ * await synchronizer1.startSync();
+ * await synchronizer2.startSync();
+ *
+ * store1.setTables({pets: {fido: {species: 'dog'}}});
+ * store2.setTables({pets: {felix: {species: 'cat'}}});
+ *
+ * // ...
+ * console.log(store1.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ * console.log(store2.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * synchronizer1.destroy();
+ * synchronizer2.destroy();
+ * ```
  * @category Creation
+ * @since v5.0.0
  */
 export function createLocalSynchronizer(
   store: MergeableStore,

package/@types/synchronizers/synchronizer-local/with-schemas/index.d.cts

@@ -2,7 +2,7 @@
  * The synchronizer-local module of the TinyBase project lets you synchronize
  * MergeableStore data to and from other MergeableStore instances on the same
  * local machine.
- * @see Synchronizing Data guide
+ * @see Synchronization guide
  * @packageDocumentation
  * @module synchronizer-local
  * @since v5.0.0
@@ -13,15 +13,89 @@ import type {OptionalSchemas} from '../../../store/with-schemas/index.d.cts';
 import type {Synchronizer} from '../../with-schemas/index.d.cts';
 
 /**
- * The LocalSynchronizer interface.
+ * The LocalSynchronizer interface represents a Synchronizer that lets you
+ * synchronize MergeableStore data to and from other MergeableStore instances on
+ * the same local machine.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * export interface LocalSynchronizer extends Synchronizer {}
+ * ```
+ *
+ * You should use the createLocalSynchronizer function to create a
+ * LocalSynchronizer object.
+ *
+ * Having no specialized methods, it is a synonym for the Synchronizer
+ * interface. This is also something of a showcase Synchronizer, rather than
+ * something you would use in a production environment. If you _do_ need to
+ * synchronize two in-memory MergeableStore instances, you may prefer to use the
+ * merge function on either one of them instead of going to the effort of
+ * setting up this Synchronizer.
  * @category Synchronizer
+ * @since v5.0.0
  */
 export interface LocalSynchronizer<Schemas extends OptionalSchemas>
   extends Synchronizer<Schemas> {}
 
 /**
- * The createLocalSynchronizer function.
+ * The createLocalSynchronizer function creates a LocalSynchronizer object that
+ * can synchronize MergeableStore data to and from other MergeableStore
+ * instances on the same local machine.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createLocalSynchronizer(
+ *   store: MergeableStore,
+ *   onIgnoredError?: (error: any) => void,
+ * ): LocalSynchronizer;
+ * ```
+ *
+ * This is something of a showcase Synchronizer, rather than something you would
+ * use in a production environment. If you _do_ need to synchronize two
+ * in-memory MergeableStore instances, you may prefer to use the merge function
+ * on either one of them instead of going to the effort of setting up this
+ * Synchronizer.
+ *
+ * As well as providing a reference to the MergeableStore to persist, you can
+ * provide a handler for any otherwise ignored synchronization errors.
+ * @param store The MergeableStore to synchronize.
+ * @param onIgnoredError An optional handler for the errors that the
+ * Synchronizer would otherwise ignore when trying to synchronize data. This is
+ * suitable for debugging synchronization issues in a development environment.
+ * @returns A reference to the new LocalSynchronizer object.
+ * @example
+ * This example creates two LocalSynchronizer objects to synchronize one
+ * MergeableStore to another.
+ *
+ * ```js
+ * import {createLocalSynchronizer} from 'tinybase/synchronizers/synchronizer-local';
+ * import {createMergeableStore} from 'tinybase';
+ *
+ * const store1 = createMergeableStore();
+ * const store2 = createMergeableStore();
+ *
+ * const synchronizer1 = createLocalSynchronizer(store1);
+ * const synchronizer2 = createLocalSynchronizer(store2);
+ *
+ * await synchronizer1.startSync();
+ * await synchronizer2.startSync();
+ *
+ * store1.setTables({pets: {fido: {species: 'dog'}}});
+ * store2.setTables({pets: {felix: {species: 'cat'}}});
+ *
+ * // ...
+ * console.log(store1.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ * console.log(store2.getTables());
+ * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
+ *
+ * synchronizer1.destroy();
+ * synchronizer2.destroy();
+ * ```
  * @category Creation
+ * @since v5.0.0
  */
 export function createLocalSynchronizer<Schemas extends OptionalSchemas>(
   store: MergeableStore<Schemas>,