[sync] Ws onSend and onReceive

Author: jamesgpearce

src/@types/synchronizers/synchronizer-ws-client/docs.js

@@ -75,13 +75,23 @@
  * As well as providing a reference to the MergeableStore to persist, you must
  * provide a configured WebSocket to send synchronization messages over.
  *
+ * You can 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.
+ *
  * This method is asynchronous because it will await the websocket's connection
  * to the server. You will need to `await` a call to this function or handle the
  * return type natively as a Promise.
  * @param store The MergeableStore to synchronize.
  * @param webSocket The WebSocket to send synchronization messages over.
  * @param requestTimeoutSeconds An optional time in seconds that the
  * Synchronizer will wait for responses to request messages, defaulting to 1.
+ * @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-ws-client/index.d.ts

@@ -1,7 +1,7 @@
 /// synchronizer-ws-client
 
+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';
 import type {WebSocket as WsWebSocket} from 'ws';
 
 /// WebSocketTypes
@@ -19,5 +19,7 @@ export function createWsSynchronizer<WebSocketType extends WebSocketTypes>(
   store: MergeableStore,
   webSocket: WebSocketType,
   requestTimeoutSeconds?: number,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): Promise<WsSynchronizer<WebSocketType>>;

src/@types/synchronizers/synchronizer-ws-client/with-schemas/index.d.ts

@@ -1,8 +1,8 @@
 /// synchronizer-ws-client
 
+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';
 import type {WebSocket as WsWebSocket} from 'ws';
 
 /// WebSocketTypes
@@ -25,5 +25,7 @@ export function createWsSynchronizer<
   store: MergeableStore<Schemas>,
   webSocket: WebSocketType,
   requestTimeoutSeconds?: number,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ): Promise<WsSynchronizer<Schemas, WebSocketType>>;

src/synchronizers/synchronizer-ws-client/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 {
   WebSocketTypes,
   createWsSynchronizer as createWsSynchronizerDecl,
@@ -16,6 +20,8 @@ export const createWsSynchronizer = (async <
   store: MergeableStore,
   webSocket: WebSocketType,
   requestTimeoutSeconds: number = 1,
+  onSend?: Send,
+  onReceive?: Receive,
   onIgnoredError?: (error: any) => void,
 ) => {
   const addEventListener = (event: string, handler: (...args: any[]) => void) =>
@@ -41,6 +47,8 @@ export const createWsSynchronizer = (async <
     registerReceive,
     destroy,
     requestTimeoutSeconds,
+    onSend,
+    onReceive,
     onIgnoredError,
     {getWebSocket: () => webSocket},
   );