tinybase 5.0.0-beta.27 → 5.0.0-beta.28

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

@@ -2,7 +2,7 @@
  * The synchronizer-ws module of the TinyBase project lets you synchronize
  * MergeableStore data to and from other MergeableStore instances via WebSockets
  * facilitated by a server.
- * @see Synchronizing Data guide
+ * @see Synchronization guide
  * @see Todo App v6 (collaboration) demo
  * @packageDocumentation
  * @module synchronizer-ws-client
@@ -21,6 +21,8 @@ import type {WebSocket as WsWebSocket} from 'ws';
  * This includes the browser-native WebSocket type, as well as the WebSocket
  * type from the well-known `ws` package (such that the Synchronizer can be used
  * in a server environment).
+ * @category Creation
+ * @since v5.0.0
  */
 export type WebSocketTypes = WebSocket | WsWebSocket;
 
@@ -29,12 +31,12 @@ export type WebSocketTypes = WebSocket | WsWebSocket;
  * synchronize MergeableStore data to and from other MergeableStore instances
  * via WebSockets facilitated by a server.
  *
+ * You should use the createWsSynchronizer function to create a WsSynchronizer
+ * object.
+ *
  * It is a minor extension to the Synchronizer interface and simply provides an
  * extra getWebSocket method for accessing a reference to the WebSocket being
  * used.
- *
- * You should use the createWsSynchronizer function to create a WsSynchronizer
- * object.
  * @category Synchronizer
  * @since v5.0.0
  */
@@ -43,7 +45,7 @@ export interface WsSynchronizer<
   WebSocketType extends WebSocketTypes,
 > extends Synchronizer<Schemas> {
   /**
-   * The getWebSocket method returns reference to the WebSocket being used for
+   * The getWebSocket method returns a reference to the WebSocket being used for
    * synchronization.
    * @returns The WebSocket reference.
    * @example
@@ -75,8 +77,77 @@ export interface WsSynchronizer<
 }
 
 /**
- * The createWsSynchronizer function.
+ * The createWsSynchronizer function creates a WsSynchronizer object that can
+ * synchronize MergeableStore data to and from other MergeableStore instances
+ * via WebSockets facilitated by a WsServer.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createWsSynchronizer<WebSocketType extends WebSocketTypes>(
+ *   store: MergeableStore,
+ *   webSocket: WebSocketType,
+ *   requestTimeoutSeconds?: number,
+ *   onIgnoredError?: (error: any) => void,
+ * ): Promise<WsSynchronizer<WebSocketType>>;
+ * ```
+ *
+ * As well as providing a reference to the MergeableStore to persist, you must
+ * provide a configured WebSocket to send synchronization messages over.
+ *
+ * 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 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 WsSynchronizer object.
+ * @example
+ * This example creates two WsSynchronizer objects to synchronize one
+ * MergeableStore to another via a server.
+ *
+ * ```js
+ * import {WebSocket, WebSocketServer} from 'ws';
+ * import {createMergeableStore} from 'tinybase';
+ * import {createWsServer} from 'tinybase/synchronizers/synchronizer-ws-server';
+ * import {createWsSynchronizer} from 'tinybase/synchronizers/synchronizer-ws-client';
+ *
+ * const server = createWsServer(new WebSocketServer({port: 8047}));
+ *
+ * const store1 = createMergeableStore();
+ * const store2 = createMergeableStore();
+ *
+ * const synchronizer1 = await createWsSynchronizer(
+ *   store1,
+ *   new WebSocket('ws://localhost:8047'),
+ * );
+ * const synchronizer2 = await createWsSynchronizer(
+ *   store2,
+ *   new WebSocket('ws://localhost:8047'),
+ * );
+ *
+ * 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();
+ * server.destroy();
+ * ```
  * @category Creation
+ * @since v5.0.0
  */
 export function createWsSynchronizer<
   Schemas extends OptionalSchemas,

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

@@ -2,7 +2,7 @@
  * The synchronizer-ws module of the TinyBase project lets you synchronize
  * MergeableStore data to and from other MergeableStore instances via WebSockets
  * facilitated by a server.
- * @see Synchronizing Data guide
+ * @see Synchronization guide
  * @see Todo App v6 (collaboration) demo
  * @packageDocumentation
  * @module synchronizer-ws-client
@@ -21,6 +21,8 @@ import type {WebSocket as WsWebSocket} from 'ws';
  * This includes the browser-native WebSocket type, as well as the WebSocket
  * type from the well-known `ws` package (such that the Synchronizer can be used
  * in a server environment).
+ * @category Creation
+ * @since v5.0.0
  */
 export type WebSocketTypes = WebSocket | WsWebSocket;
 
@@ -29,12 +31,12 @@ export type WebSocketTypes = WebSocket | WsWebSocket;
  * synchronize MergeableStore data to and from other MergeableStore instances
  * via WebSockets facilitated by a server.
  *
+ * You should use the createWsSynchronizer function to create a WsSynchronizer
+ * object.
+ *
  * It is a minor extension to the Synchronizer interface and simply provides an
  * extra getWebSocket method for accessing a reference to the WebSocket being
  * used.
- *
- * You should use the createWsSynchronizer function to create a WsSynchronizer
- * object.
  * @category Synchronizer
  * @since v5.0.0
  */
@@ -43,7 +45,7 @@ export interface WsSynchronizer<
   WebSocketType extends WebSocketTypes,
 > extends Synchronizer<Schemas> {
   /**
-   * The getWebSocket method returns reference to the WebSocket being used for
+   * The getWebSocket method returns a reference to the WebSocket being used for
    * synchronization.
    * @returns The WebSocket reference.
    * @example
@@ -75,8 +77,77 @@ export interface WsSynchronizer<
 }
 
 /**
- * The createWsSynchronizer function.
+ * The createWsSynchronizer function creates a WsSynchronizer object that can
+ * synchronize MergeableStore data to and from other MergeableStore instances
+ * via WebSockets facilitated by a WsServer.
+ *
+ * This has schema-based typing. The following is a simplified representation:
+ *
+ * ```ts override
+ * createWsSynchronizer<WebSocketType extends WebSocketTypes>(
+ *   store: MergeableStore,
+ *   webSocket: WebSocketType,
+ *   requestTimeoutSeconds?: number,
+ *   onIgnoredError?: (error: any) => void,
+ * ): Promise<WsSynchronizer<WebSocketType>>;
+ * ```
+ *
+ * As well as providing a reference to the MergeableStore to persist, you must
+ * provide a configured WebSocket to send synchronization messages over.
+ *
+ * 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 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 WsSynchronizer object.
+ * @example
+ * This example creates two WsSynchronizer objects to synchronize one
+ * MergeableStore to another via a server.
+ *
+ * ```js
+ * import {WebSocket, WebSocketServer} from 'ws';
+ * import {createMergeableStore} from 'tinybase';
+ * import {createWsServer} from 'tinybase/synchronizers/synchronizer-ws-server';
+ * import {createWsSynchronizer} from 'tinybase/synchronizers/synchronizer-ws-client';
+ *
+ * const server = createWsServer(new WebSocketServer({port: 8047}));
+ *
+ * const store1 = createMergeableStore();
+ * const store2 = createMergeableStore();
+ *
+ * const synchronizer1 = await createWsSynchronizer(
+ *   store1,
+ *   new WebSocket('ws://localhost:8047'),
+ * );
+ * const synchronizer2 = await createWsSynchronizer(
+ *   store2,
+ *   new WebSocket('ws://localhost:8047'),
+ * );
+ *
+ * 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();
+ * server.destroy();
+ * ```
  * @category Creation
+ * @since v5.0.0
  */
 export function createWsSynchronizer<
   Schemas extends OptionalSchemas,