[sync] Broadcast onSend and onReceive

Author: jamesgpearce

src/@types/synchronizers/synchronizer-broadcast-channel/docs.js

@@ -57,8 +57,17 @@
  * 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.

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

@@ -1,7 +1,7 @@
 /// synchronizer-broadcast-channel
 
+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';
 
 /// BroadcastChannelSynchronizer
 export interface BroadcastChannelSynchronizer extends Synchronizer {
@@ -13,5 +13,7 @@ export interface BroadcastChannelSynchronizer extends Synchronizer {
 export function createBroadcastChannelSynchronizer(
   store: MergeableStore,
   channelName: string,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): BroadcastChannelSynchronizer;

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

@@ -1,8 +1,8 @@
 /// synchronizer-broadcast-channel
 
+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';
 
 /// BroadcastChannelSynchronizer
 export interface BroadcastChannelSynchronizer<Schemas extends OptionalSchemas>
@@ -17,5 +17,7 @@ export function createBroadcastChannelSynchronizer<
 >(
   store: MergeableStore<Schemas>,
   channelName: string,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): BroadcastChannelSynchronizer<Schemas>;

src/synchronizers/synchronizer-broadcast-channel/index.ts

@@ -1,4 +1,8 @@
-import type {Message, Receive} from '../../@types/synchronizers/index.d.ts';
+import type {
+  Message,
+  Receive,
+  Send,
+} from '../../@types/synchronizers/index.d.ts';
 import type {IdOrNull} from '../../@types/common/index.d.ts';
 import type {MergeableStore} from '../../@types/mergeable-store/index.d.ts';
 import type {createBroadcastChannelSynchronizer as createBroadcastChannelSynchronizerDecl} from '../../@types/synchronizers/synchronizer-broadcast-channel/index.d.ts';
@@ -9,6 +13,8 @@ import {isUndefined} from '../../common/other.ts';
 export const createBroadcastChannelSynchronizer = ((
   store: MergeableStore,
   channelName: string,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ) => {
   const clientId = getUniqueId();
@@ -41,6 +47,8 @@ export const createBroadcastChannelSynchronizer = ((
     registerReceive,
     destroy,
     0.01,
+    onSend,
+    onReceive,
     onIgnoredError,
     {getChannelName: () => channelName},
   );