tinybase 5.1.0-beta.0 → 5.1.0-beta.1

package/@types/persisters/index.d.cts

@@ -1199,6 +1199,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * in one call. This will also start to run the first task in the queue (which
    * once complete will then run the next, and so on), and so this method itself
    * is also asynchronous and returns a promise of the Persister.
+   * @param actions One or many functions which will be scheduled, and which can
+   * be asynchronous.
    * @returns A reference to the Persister object.
    * @example
    * This example creates a custom Persister object against a newly-created
@@ -1234,7 +1236,7 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * @category Lifecycle
    * @since v4.0.0
    */
-  schedule(...actions: Promise<any>[]): Promise<this>;
+  schedule(...actions: (() => Promise<any>)[]): Promise<this>;
 
   /**
    * The getStore method returns a reference to the underlying Store or

package/@types/persisters/index.d.ts

@@ -1199,6 +1199,8 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * in one call. This will also start to run the first task in the queue (which
    * once complete will then run the next, and so on), and so this method itself
    * is also asynchronous and returns a promise of the Persister.
+   * @param actions One or many functions which will be scheduled, and which can
+   * be asynchronous.
    * @returns A reference to the Persister object.
    * @example
    * This example creates a custom Persister object against a newly-created
@@ -1234,7 +1236,7 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * @category Lifecycle
    * @since v4.0.0
    */
-  schedule(...actions: Promise<any>[]): Promise<this>;
+  schedule(...actions: (() => Promise<any>)[]): Promise<this>;
 
   /**
    * The getStore method returns a reference to the underlying Store or

package/@types/persisters/with-schemas/index.d.cts

@@ -1278,6 +1278,8 @@ export interface Persister<
    * in one call. This will also start to run the first task in the queue (which
    * once complete will then run the next, and so on), and so this method itself
    * is also asynchronous and returns a promise of the Persister.
+   * @param actions One or many functions which will be scheduled, and which can
+   * be asynchronous.
    * @returns A reference to the Persister object.
    * @example
    * This example creates a custom Persister object against a newly-created
@@ -1313,7 +1315,7 @@ export interface Persister<
    * @category Lifecycle
    * @since v4.0.0
    */
-  schedule(...actions: Promise<any>[]): Promise<this>;
+  schedule(...actions: (() => Promise<any>)[]): Promise<this>;
 
   /**
    * The getStore method returns a reference to the underlying Store or

package/@types/persisters/with-schemas/index.d.ts

@@ -1278,6 +1278,8 @@ export interface Persister<
    * in one call. This will also start to run the first task in the queue (which
    * once complete will then run the next, and so on), and so this method itself
    * is also asynchronous and returns a promise of the Persister.
+   * @param actions One or many functions which will be scheduled, and which can
+   * be asynchronous.
    * @returns A reference to the Persister object.
    * @example
    * This example creates a custom Persister object against a newly-created
@@ -1313,7 +1315,7 @@ export interface Persister<
    * @category Lifecycle
    * @since v4.0.0
    */
-  schedule(...actions: Promise<any>[]): Promise<this>;
+  schedule(...actions: (() => Promise<any>)[]): Promise<this>;
 
   /**
    * The getStore method returns a reference to the underlying Store or

package/@types/synchronizers/index.d.cts

@@ -77,15 +77,12 @@ export const enum Message {
 }
 
 /**
- * The Receive type describes a function that knows how to handle the arrival of
- * a message as part of the synchronization protocol.
- *
- * When a message arrives (most likely from another system), the function will
- * be called with parameters that indicate where the message came from, and its
- * meaning and content.
- * @param fromClientId The Id of the other client (in other words, the other
- * system) that sent the message.
- * @param requestId The optional Id of the message, which should be returned in
+ * The Send type describes a function that knows how to dispatch a message as
+ * part of the synchronization protocol.
+ * @param toClientId The optional Id of the other client (in other words, the
+ * other system) to which the message should be sent. If omitted, this is to be
+ * a broadcast.
+ * @param requestId The optional Id of the message, which should be awaited in
  * the response (if requested) to constitute a matched request/response
  * transaction.
  * @param message A number that indicates the type of the message, according to
@@ -94,20 +91,23 @@ export const enum Message {
  * @category Synchronization
  * @since v5.0.0
  */
-export type Receive = (
-  fromClientId: Id,
+export type Send = (
+  toClientId: IdOrNull,
   requestId: IdOrNull,
   message: Message,
   body: any,
 ) => void;
 
 /**
- * The Send type describes a function that knows how to dispatch a message as
- * part of the synchronization protocol.
- * @param toClientId The optional Id of the other client (in other words, the
- * other system) to which the message should be sent. If omitted, this is to be
- * a broadcast.
- * @param requestId The optional Id of the message, which should be awaited in
+ * The Receive type describes a function that knows how to handle the arrival of
+ * a message as part of the synchronization protocol.
+ *
+ * When a message arrives (most likely from another system), the function will
+ * be called with parameters that indicate where the message came from, and its
+ * meaning and content.
+ * @param fromClientId The Id of the other client (in other words, the other
+ * system) that sent the message.
+ * @param requestId The optional Id of the message, which should be returned in
  * the response (if requested) to constitute a matched request/response
  * transaction.
  * @param message A number that indicates the type of the message, according to
@@ -116,8 +116,8 @@ export type Receive = (
  * @category Synchronization
  * @since v5.0.0
  */
-export type Send = (
-  toClientId: IdOrNull,
+export type Receive = (
+  fromClientId: Id,
   requestId: IdOrNull,
   message: Message,
   body: any,
@@ -337,7 +337,7 @@ export interface Synchronizer extends Persister<Persists.MergeableStoreOnly> {
    * Synchronizer, and is used for debugging purposes.
    *
    * The SynchronizerStats object contains a count of the number of times the
-   * Persister has sent and received messages.
+   * Synchronizer has sent and received messages.
    *
    * The method is intended to be used during development to ensure your
    * synchronization layer is acting as expected, for example.
@@ -387,15 +387,29 @@ export interface Synchronizer extends Persister<Persists.MergeableStoreOnly> {
  * must provide parameters which identify how to send and receive changes to and
  * from this MergeableStore and its peers. This is entirely dependent upon the
  * medium of communication used.
+ *
+ * You must also provide a callback for when the Synchronizer is destroyed
+ * (which is a good place to clean up resources and stop communication
+ * listeners), and indicate how long the Synchronizer will wait for responses to
+ * message requests before timing out.
+ *
+ * A final set of optional handlers can be provided to help debug sends,
+ * receives, and errors respectively.
  * @param store The MergeableStore to synchronize.
  * @param send A Send function for sending a message.
  * @param registerReceive A callback (called once when the Synchronizer is
  * created) that is passed a Receive function that you need to ensure will
  * receive messages addressed or broadcast to this client.
- * @param destroy A function called when destroying the Persister which can be
- * used to clean up underlying resources.
+ * @param destroy A function called when destroying the Synchronizer which can
+ * be used to clean up underlying resources.
  * @param requestTimeoutSeconds An number of seconds before a request sent from
- * this Persister to another peer times out.
+ * this Synchronizer to another peer times out.
+ * @param onSend An optional handler for the messages that this Synchronizer
+ * sends. This is suitable for debugging synchronization issues in a development
+ * environment, since v5.1.
+ * @param onReceive An optional handler for the messages that this Synchronizer
+ * receives. This is suitable for debugging synchronization issues in a
+ * development environment, since v5.1.
  * @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.
@@ -469,5 +483,7 @@ export function createCustomSynchronizer(
   registerReceive: (receive: Receive) => void,
   destroy: () => void,
   requestTimeoutSeconds: number,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): Synchronizer;

package/@types/synchronizers/index.d.ts

@@ -77,15 +77,12 @@ export const enum Message {
 }
 
 /**
- * The Receive type describes a function that knows how to handle the arrival of
- * a message as part of the synchronization protocol.
- *
- * When a message arrives (most likely from another system), the function will
- * be called with parameters that indicate where the message came from, and its
- * meaning and content.
- * @param fromClientId The Id of the other client (in other words, the other
- * system) that sent the message.
- * @param requestId The optional Id of the message, which should be returned in
+ * The Send type describes a function that knows how to dispatch a message as
+ * part of the synchronization protocol.
+ * @param toClientId The optional Id of the other client (in other words, the
+ * other system) to which the message should be sent. If omitted, this is to be
+ * a broadcast.
+ * @param requestId The optional Id of the message, which should be awaited in
  * the response (if requested) to constitute a matched request/response
  * transaction.
  * @param message A number that indicates the type of the message, according to
@@ -94,20 +91,23 @@ export const enum Message {
  * @category Synchronization
  * @since v5.0.0
  */
-export type Receive = (
-  fromClientId: Id,
+export type Send = (
+  toClientId: IdOrNull,
   requestId: IdOrNull,
   message: Message,
   body: any,
 ) => void;
 
 /**
- * The Send type describes a function that knows how to dispatch a message as
- * part of the synchronization protocol.
- * @param toClientId The optional Id of the other client (in other words, the
- * other system) to which the message should be sent. If omitted, this is to be
- * a broadcast.
- * @param requestId The optional Id of the message, which should be awaited in
+ * The Receive type describes a function that knows how to handle the arrival of
+ * a message as part of the synchronization protocol.
+ *
+ * When a message arrives (most likely from another system), the function will
+ * be called with parameters that indicate where the message came from, and its
+ * meaning and content.
+ * @param fromClientId The Id of the other client (in other words, the other
+ * system) that sent the message.
+ * @param requestId The optional Id of the message, which should be returned in
  * the response (if requested) to constitute a matched request/response
  * transaction.
  * @param message A number that indicates the type of the message, according to
@@ -116,8 +116,8 @@ export type Receive = (
  * @category Synchronization
  * @since v5.0.0
  */
-export type Send = (
-  toClientId: IdOrNull,
+export type Receive = (
+  fromClientId: Id,
   requestId: IdOrNull,
   message: Message,
   body: any,
@@ -337,7 +337,7 @@ export interface Synchronizer extends Persister<Persists.MergeableStoreOnly> {
    * Synchronizer, and is used for debugging purposes.
    *
    * The SynchronizerStats object contains a count of the number of times the
-   * Persister has sent and received messages.
+   * Synchronizer has sent and received messages.
    *
    * The method is intended to be used during development to ensure your
    * synchronization layer is acting as expected, for example.
@@ -387,15 +387,29 @@ export interface Synchronizer extends Persister<Persists.MergeableStoreOnly> {
  * must provide parameters which identify how to send and receive changes to and
  * from this MergeableStore and its peers. This is entirely dependent upon the
  * medium of communication used.
+ *
+ * You must also provide a callback for when the Synchronizer is destroyed
+ * (which is a good place to clean up resources and stop communication
+ * listeners), and indicate how long the Synchronizer will wait for responses to
+ * message requests before timing out.
+ *
+ * A final set of optional handlers can be provided to help debug sends,
+ * receives, and errors respectively.
  * @param store The MergeableStore to synchronize.
  * @param send A Send function for sending a message.
  * @param registerReceive A callback (called once when the Synchronizer is
  * created) that is passed a Receive function that you need to ensure will
  * receive messages addressed or broadcast to this client.
- * @param destroy A function called when destroying the Persister which can be
- * used to clean up underlying resources.
+ * @param destroy A function called when destroying the Synchronizer which can
+ * be used to clean up underlying resources.
  * @param requestTimeoutSeconds An number of seconds before a request sent from
- * this Persister to another peer times out.
+ * this Synchronizer to another peer times out.
+ * @param onSend An optional handler for the messages that this Synchronizer
+ * sends. This is suitable for debugging synchronization issues in a development
+ * environment, since v5.1.
+ * @param onReceive An optional handler for the messages that this Synchronizer
+ * receives. This is suitable for debugging synchronization issues in a
+ * development environment, since v5.1.
  * @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.
@@ -469,5 +483,7 @@ export function createCustomSynchronizer(
   registerReceive: (receive: Receive) => void,
   destroy: () => void,
   requestTimeoutSeconds: number,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): Synchronizer;

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

@@ -8,8 +8,8 @@
  * @since v5.0.0
  */
 
+import type {Receive, Send, Synchronizer} from '../index.d.cts';
 import type {MergeableStore} from '../../mergeable-store/index.d.cts';
-import type {Synchronizer} from '../index.d.cts';
 
 /**
  * The BroadcastChannelSynchronizer interface represents a Synchronizer that
@@ -60,8 +60,17 @@ export interface BroadcastChannelSynchronizer extends Synchronizer {
  * 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.
+ *
+ * A final set of optional handlers can be provided to help debug sends,
+ * receives, and errors respectively.
  * @param store The MergeableStore to synchronize.
  * @param channelName The name of the channel to use.
+ * @param onSend An optional handler for the messages that this Synchronizer
+ * sends. This is suitable for debugging synchronization issues in a development
+ * environment, since v5.1.
+ * @param onReceive An optional handler for the messages that this Synchronizer
+ * receives. This is suitable for debugging synchronization issues in a
+ * development environment, since v5.1.
  * @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.
@@ -107,5 +116,7 @@ export interface BroadcastChannelSynchronizer extends Synchronizer {
 export function createBroadcastChannelSynchronizer(
   store: MergeableStore,
   channelName: string,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): BroadcastChannelSynchronizer;

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

@@ -8,8 +8,8 @@
  * @since v5.0.0
  */
 
+import type {Receive, Send, Synchronizer} from '../index.d.ts';
 import type {MergeableStore} from '../../mergeable-store/index.d.ts';
-import type {Synchronizer} from '../index.d.ts';
 
 /**
  * The BroadcastChannelSynchronizer interface represents a Synchronizer that
@@ -60,8 +60,17 @@ export interface BroadcastChannelSynchronizer extends Synchronizer {
  * 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.
+ *
+ * A final set of optional handlers can be provided to help debug sends,
+ * receives, and errors respectively.
  * @param store The MergeableStore to synchronize.
  * @param channelName The name of the channel to use.
+ * @param onSend An optional handler for the messages that this Synchronizer
+ * sends. This is suitable for debugging synchronization issues in a development
+ * environment, since v5.1.
+ * @param onReceive An optional handler for the messages that this Synchronizer
+ * receives. This is suitable for debugging synchronization issues in a
+ * development environment, since v5.1.
  * @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.
@@ -107,5 +116,7 @@ export interface BroadcastChannelSynchronizer extends Synchronizer {
 export function createBroadcastChannelSynchronizer(
   store: MergeableStore,
   channelName: string,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): BroadcastChannelSynchronizer;

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

@@ -8,9 +8,9 @@
  * @since v5.0.0
  */
 
+import type {Receive, Send, Synchronizer} from '../../with-schemas/index.d.cts';
 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
@@ -65,6 +65,8 @@ export interface BroadcastChannelSynchronizer<Schemas extends OptionalSchemas>
  * createBroadcastChannelSynchronizer(
  *   store: MergeableStore,
  *   channelName: string,
+ *   onSend?: Send,
+ *   onReceive?: Receive,
  *   onIgnoredError?: (error: any) => void,
  * ): BroadcastChannelSynchronizer;
  * ```
@@ -72,8 +74,17 @@ export interface BroadcastChannelSynchronizer<Schemas extends OptionalSchemas>
  * 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.
+ *
+ * A final set of optional handlers can be provided to help debug sends,
+ * receives, and errors respectively.
  * @param store The MergeableStore to synchronize.
  * @param channelName The name of the channel to use.
+ * @param onSend An optional handler for the messages that this Synchronizer
+ * sends. This is suitable for debugging synchronization issues in a development
+ * environment, since v5.1.
+ * @param onReceive An optional handler for the messages that this Synchronizer
+ * receives. This is suitable for debugging synchronization issues in a
+ * development environment, since v5.1.
  * @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.
@@ -121,5 +132,7 @@ export function createBroadcastChannelSynchronizer<
 >(
   store: MergeableStore<Schemas>,
   channelName: string,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): BroadcastChannelSynchronizer<Schemas>;

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

@@ -8,9 +8,9 @@
  * @since v5.0.0
  */
 
+import type {Receive, Send, Synchronizer} from '../../with-schemas/index.d.ts';
 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
@@ -65,6 +65,8 @@ export interface BroadcastChannelSynchronizer<Schemas extends OptionalSchemas>
  * createBroadcastChannelSynchronizer(
  *   store: MergeableStore,
  *   channelName: string,
+ *   onSend?: Send,
+ *   onReceive?: Receive,
  *   onIgnoredError?: (error: any) => void,
  * ): BroadcastChannelSynchronizer;
  * ```
@@ -72,8 +74,17 @@ export interface BroadcastChannelSynchronizer<Schemas extends OptionalSchemas>
  * 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.
+ *
+ * A final set of optional handlers can be provided to help debug sends,
+ * receives, and errors respectively.
  * @param store The MergeableStore to synchronize.
  * @param channelName The name of the channel to use.
+ * @param onSend An optional handler for the messages that this Synchronizer
+ * sends. This is suitable for debugging synchronization issues in a development
+ * environment, since v5.1.
+ * @param onReceive An optional handler for the messages that this Synchronizer
+ * receives. This is suitable for debugging synchronization issues in a
+ * development environment, since v5.1.
  * @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.
@@ -121,5 +132,7 @@ export function createBroadcastChannelSynchronizer<
 >(
   store: MergeableStore<Schemas>,
   channelName: string,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): BroadcastChannelSynchronizer<Schemas>;

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

@@ -8,8 +8,8 @@
  * @since v5.0.0
  */
 
+import type {Receive, Send, Synchronizer} from '../index.d.cts';
 import type {MergeableStore} from '../../mergeable-store/index.d.cts';
-import type {Synchronizer} from '../index.d.cts';
 
 /**
  * The LocalSynchronizer interface represents a Synchronizer that lets you
@@ -41,9 +41,16 @@ export interface LocalSynchronizer extends Synchronizer {}
  * 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.
+ * As well as providing a reference to the MergeableStore to persist, a final
+ * set of optional handlers can be provided to help debug sends, receives, and
+ * errors respectively.
  * @param store The MergeableStore to synchronize.
+ * @param onSend An optional handler for the messages that this Synchronizer
+ * sends. This is suitable for debugging synchronization issues in a development
+ * environment, since v5.1.
+ * @param onReceive An optional handler for the messages that this Synchronizer
+ * receives. This is suitable for debugging synchronization issues in a
+ * development environment, since v5.1.
  * @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.
@@ -82,5 +89,7 @@ export interface LocalSynchronizer extends Synchronizer {}
  */
 export function createLocalSynchronizer(
   store: MergeableStore,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): LocalSynchronizer;

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

@@ -8,8 +8,8 @@
  * @since v5.0.0
  */
 
+import type {Receive, Send, Synchronizer} from '../index.d.ts';
 import type {MergeableStore} from '../../mergeable-store/index.d.ts';
-import type {Synchronizer} from '../index.d.ts';
 
 /**
  * The LocalSynchronizer interface represents a Synchronizer that lets you
@@ -41,9 +41,16 @@ export interface LocalSynchronizer extends Synchronizer {}
  * 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.
+ * As well as providing a reference to the MergeableStore to persist, a final
+ * set of optional handlers can be provided to help debug sends, receives, and
+ * errors respectively.
  * @param store The MergeableStore to synchronize.
+ * @param onSend An optional handler for the messages that this Synchronizer
+ * sends. This is suitable for debugging synchronization issues in a development
+ * environment, since v5.1.
+ * @param onReceive An optional handler for the messages that this Synchronizer
+ * receives. This is suitable for debugging synchronization issues in a
+ * development environment, since v5.1.
  * @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.
@@ -82,5 +89,7 @@ export interface LocalSynchronizer extends Synchronizer {}
  */
 export function createLocalSynchronizer(
   store: MergeableStore,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): LocalSynchronizer;

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

@@ -8,9 +8,9 @@
  * @since v5.0.0
  */
 
+import type {Receive, Send, Synchronizer} from '../../with-schemas/index.d.cts';
 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 LocalSynchronizer interface represents a Synchronizer that lets you
@@ -48,6 +48,8 @@ export interface LocalSynchronizer<Schemas extends OptionalSchemas>
  * ```ts override
  * createLocalSynchronizer(
  *   store: MergeableStore,
+ *   onSend?: Send,
+ *   onReceive?: Receive,
  *   onIgnoredError?: (error: any) => void,
  * ): LocalSynchronizer;
  * ```
@@ -58,9 +60,16 @@ export interface LocalSynchronizer<Schemas extends OptionalSchemas>
  * 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.
+ * As well as providing a reference to the MergeableStore to persist, a final
+ * set of optional handlers can be provided to help debug sends, receives, and
+ * errors respectively.
  * @param store The MergeableStore to synchronize.
+ * @param onSend An optional handler for the messages that this Synchronizer
+ * sends. This is suitable for debugging synchronization issues in a development
+ * environment, since v5.1.
+ * @param onReceive An optional handler for the messages that this Synchronizer
+ * receives. This is suitable for debugging synchronization issues in a
+ * development environment, since v5.1.
  * @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.
@@ -99,5 +108,7 @@ export interface LocalSynchronizer<Schemas extends OptionalSchemas>
  */
 export function createLocalSynchronizer<Schemas extends OptionalSchemas>(
   store: MergeableStore<Schemas>,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): LocalSynchronizer<Schemas>;

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

@@ -8,9 +8,9 @@
  * @since v5.0.0
  */
 
+import type {Receive, Send, Synchronizer} from '../../with-schemas/index.d.ts';
 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 LocalSynchronizer interface represents a Synchronizer that lets you
@@ -48,6 +48,8 @@ export interface LocalSynchronizer<Schemas extends OptionalSchemas>
  * ```ts override
  * createLocalSynchronizer(
  *   store: MergeableStore,
+ *   onSend?: Send,
+ *   onReceive?: Receive,
  *   onIgnoredError?: (error: any) => void,
  * ): LocalSynchronizer;
  * ```
@@ -58,9 +60,16 @@ export interface LocalSynchronizer<Schemas extends OptionalSchemas>
  * 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.
+ * As well as providing a reference to the MergeableStore to persist, a final
+ * set of optional handlers can be provided to help debug sends, receives, and
+ * errors respectively.
  * @param store The MergeableStore to synchronize.
+ * @param onSend An optional handler for the messages that this Synchronizer
+ * sends. This is suitable for debugging synchronization issues in a development
+ * environment, since v5.1.
+ * @param onReceive An optional handler for the messages that this Synchronizer
+ * receives. This is suitable for debugging synchronization issues in a
+ * development environment, since v5.1.
  * @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.
@@ -99,5 +108,7 @@ export interface LocalSynchronizer<Schemas extends OptionalSchemas>
  */
 export function createLocalSynchronizer<Schemas extends OptionalSchemas>(
   store: MergeableStore<Schemas>,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): LocalSynchronizer<Schemas>;