tinybase 6.1.0-beta.3 → 6.1.0-beta.5

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

@@ -100,8 +100,8 @@ export interface LocalSynchronizer<Schemas extends OptionalSchemas>
  * console.log(store2.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * synchronizer1.destroy();
- * synchronizer2.destroy();
+ * await synchronizer1.destroy();
+ * await synchronizer2.destroy();
  * ```
  * @category Creation
  * @since v5.0.0

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

@@ -63,8 +63,8 @@ export interface WsSynchronizer<WebSocketType extends WebSocketTypes>
    * console.log(synchronizer.getWebSocket() == webSocket);
    * // -> true
    *
-   * synchronizer.destroy();
-   * server.destroy();
+   * await synchronizer.destroy();
+   * await server.destroy();
    * ```
    * @category Getter
    * @since v5.0.0
@@ -143,9 +143,9 @@ export interface WsSynchronizer<WebSocketType extends WebSocketTypes>
  * console.log(store2.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * synchronizer1.destroy();
- * synchronizer2.destroy();
- * server.destroy();
+ * await synchronizer1.destroy();
+ * await synchronizer2.destroy();
+ * await server.destroy();
  * ```
  * @category Creation
  * @since v5.0.0

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

@@ -66,8 +66,8 @@ export interface WsSynchronizer<
    * console.log(synchronizer.getWebSocket() == webSocket);
    * // -> true
    *
-   * synchronizer.destroy();
-   * server.destroy();
+   * await synchronizer.destroy();
+   * await server.destroy();
    * ```
    * @category Getter
    * @since v5.0.0
@@ -159,9 +159,9 @@ export interface WsSynchronizer<
  * console.log(store2.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * synchronizer1.destroy();
- * synchronizer2.destroy();
- * server.destroy();
+ * await synchronizer1.destroy();
+ * await synchronizer2.destroy();
+ * await server.destroy();
  * ```
  * @category Creation
  * @since v5.0.0

package/@types/synchronizers/synchronizer-ws-server/index.d.ts

@@ -118,7 +118,7 @@ export interface WsServer {
    * console.log(server.getWebSocketServer() == webSocketServer);
    * // -> true
    *
-   * server.destroy();
+   * await server.destroy();
    * ```
    * @category Getter
    * @since v5.0.0
@@ -161,14 +161,14 @@ export interface WsServer {
    * console.log(server.getPathIds());
    * // -> ['roomA', 'roomB']
    *
-   * synchronizer3.destroy();
+   * await synchronizer3.destroy();
    * // ...
    * console.log(server.getPathIds());
    * // -> ['roomA']
    *
-   * synchronizer1.destroy();
-   * synchronizer2.destroy();
-   * server.destroy();
+   * await synchronizer1.destroy();
+   * await synchronizer2.destroy();
+   * await server.destroy();
    * ```
    * @category Getter
    * @since v5.0.0
@@ -210,14 +210,14 @@ export interface WsServer {
    * console.log(server.getClientIds('roomB').length);
    * // -> 1
    *
-   * synchronizer3.destroy();
+   * await synchronizer3.destroy();
    * // ...
    * console.log(server.getClientIds('roomB').length);
    * // -> 0
    *
-   * synchronizer1.destroy();
-   * synchronizer2.destroy();
-   * server.destroy();
+   * await synchronizer1.destroy();
+   * await synchronizer2.destroy();
+   * await server.destroy();
    * ```
    * @category Getter
    * @since v5.0.0
@@ -266,18 +266,18 @@ export interface WsServer {
    * // -> 'roomB added'
    * // -> ['roomA', 'roomB']
    *
-   * synchronizer1.destroy();
+   * await synchronizer1.destroy();
    * // ...
    * // -> 'roomA removed'
    * // -> ['roomB']
    *
-   * synchronizer2.destroy();
+   * await synchronizer2.destroy();
    * // ...
    * // -> 'roomB removed'
    * // -> []
    *
    * server.delListener(listenerId);
-   * server.destroy();
+   * await server.destroy();
    * ```
    * @category Listener
    * @since v5.0.0
@@ -331,14 +331,14 @@ export interface WsServer {
    * );
    * // The listener is not called.
    *
-   * synchronizer1.destroy();
+   * await synchronizer1.destroy();
    * // ...
    * // -> '0 client(s) in roomA'
    *
-   * synchronizer2.destroy();
+   * await synchronizer2.destroy();
    *
    * server.delListener(listenerId);
-   * server.destroy();
+   * await server.destroy();
    * ```
    * @example
    * This example creates a WsServer, and listens to changes to the clients
@@ -369,16 +369,16 @@ export interface WsServer {
    * );
    * // -> '1 client(s) in roomB'
    *
-   * synchronizer1.destroy();
+   * await synchronizer1.destroy();
    * // ...
    * // -> '0 client(s) in roomA'
    *
-   * synchronizer2.destroy();
+   * await synchronizer2.destroy();
    * // ...
    * // -> '0 client(s) in roomB'
    *
    * server.delListener(listenerId);
-   * server.destroy();
+   * await server.destroy();
    * ```
    * @category Listener
    * @since v5.0.0
@@ -414,11 +414,11 @@ export interface WsServer {
    *
    * server.delListener(listenerId);
    *
-   * synchronizer.destroy();
+   * await synchronizer.destroy();
    * // -> undefined
    * // The listener is not called.
    *
-   * server.destroy();
+   * await server.destroy();
    * ```
    * @category Listener
    * @since v5.0.0
@@ -455,9 +455,9 @@ export interface WsServer {
    * console.log(server.getStats());
    * // -> {paths: 1, clients: 2}
    *
-   * synchronizer1.destroy();
-   * synchronizer2.destroy();
-   * server.destroy();
+   * await synchronizer1.destroy();
+   * await synchronizer2.destroy();
+   * await server.destroy();
    * ```
    * @category Development
    * @since v5.0.0
@@ -468,7 +468,7 @@ export interface WsServer {
    * use.
    *
    * This closes the underlying WebSocketServer that was provided when the
-   * WsServer was created.
+   * WsServer was created. This method is asynchronous.
    * @example
    * This example creates a WsServer and then destroys it again, closing the
    * underlying WebSocketServer.
@@ -483,14 +483,14 @@ export interface WsServer {
    * });
    * const server = createWsServer(webSocketServer);
    *
-   * server.destroy();
+   * await server.destroy();
    * // ...
    * // -> 'WebSocketServer closed'
    * ```
    * @category Getter
    * @since v5.0.0
    */
-  destroy(): void;
+  destroy(): Promise<void>;
 }
 
 /**
@@ -568,9 +568,9 @@ export interface WsServer {
  * console.log(clientStore2.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * synchronizer1.destroy();
- * synchronizer2.destroy();
- * server.destroy();
+ * await synchronizer1.destroy();
+ * await synchronizer2.destroy();
+ * await server.destroy();
  * ```
  * @example
  * This longer example creates a WsServer that persists a MergeableStore to file
@@ -621,8 +621,8 @@ export interface WsServer {
  * console.log(clientStore2.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * synchronizer1.destroy();
- * synchronizer2.destroy();
+ * await synchronizer1.destroy();
+ * await synchronizer2.destroy();
  *
  * // ...
  * // Client 3 connects later
@@ -637,8 +637,8 @@ export interface WsServer {
  * console.log(clientStore3.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * synchronizer3.destroy();
- * server.destroy();
+ * await synchronizer3.destroy();
+ * await server.destroy();
  *
  * // Remove file for the purposes of this demo.
  * rmSync('petShop.json');
@@ -680,8 +680,8 @@ export interface WsServer {
  * console.log(clientStore.getContent());
  * // -> [{pets: {fido: {species: 'dog'}}}, {"pathId": "petShop"}]
  *
- * synchronizer.destroy();
- * server.destroy();
+ * await synchronizer.destroy();
+ * await server.destroy();
  *
  * // Remove file for the purposes of this demo.
  * rmSync('petShop.json');
@@ -712,8 +712,8 @@ export interface WsServer {
  * );
  * // -> 'Local client connected'
  *
- * synchronizer.destroy();
- * server.destroy();
+ * await synchronizer.destroy();
+ * await server.destroy();
  * ```
  * @category Creation
  * @since v5.0.0

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

@@ -124,7 +124,7 @@ export interface WsServer {
    * console.log(server.getWebSocketServer() == webSocketServer);
    * // -> true
    *
-   * server.destroy();
+   * await server.destroy();
    * ```
    * @category Getter
    * @since v5.0.0
@@ -167,14 +167,14 @@ export interface WsServer {
    * console.log(server.getPathIds());
    * // -> ['roomA', 'roomB']
    *
-   * synchronizer3.destroy();
+   * await synchronizer3.destroy();
    * // ...
    * console.log(server.getPathIds());
    * // -> ['roomA']
    *
-   * synchronizer1.destroy();
-   * synchronizer2.destroy();
-   * server.destroy();
+   * await synchronizer1.destroy();
+   * await synchronizer2.destroy();
+   * await server.destroy();
    * ```
    * @category Getter
    * @since v5.0.0
@@ -216,14 +216,14 @@ export interface WsServer {
    * console.log(server.getClientIds('roomB').length);
    * // -> 1
    *
-   * synchronizer3.destroy();
+   * await synchronizer3.destroy();
    * // ...
    * console.log(server.getClientIds('roomB').length);
    * // -> 0
    *
-   * synchronizer1.destroy();
-   * synchronizer2.destroy();
-   * server.destroy();
+   * await synchronizer1.destroy();
+   * await synchronizer2.destroy();
+   * await server.destroy();
    * ```
    * @category Getter
    * @since v5.0.0
@@ -272,18 +272,18 @@ export interface WsServer {
    * // -> 'roomB added'
    * // -> ['roomA', 'roomB']
    *
-   * synchronizer1.destroy();
+   * await synchronizer1.destroy();
    * // ...
    * // -> 'roomA removed'
    * // -> ['roomB']
    *
-   * synchronizer2.destroy();
+   * await synchronizer2.destroy();
    * // ...
    * // -> 'roomB removed'
    * // -> []
    *
    * server.delListener(listenerId);
-   * server.destroy();
+   * await server.destroy();
    * ```
    * @category Listener
    * @since v5.0.0
@@ -337,14 +337,14 @@ export interface WsServer {
    * );
    * // The listener is not called.
    *
-   * synchronizer1.destroy();
+   * await synchronizer1.destroy();
    * // ...
    * // -> '0 client(s) in roomA'
    *
-   * synchronizer2.destroy();
+   * await synchronizer2.destroy();
    *
    * server.delListener(listenerId);
-   * server.destroy();
+   * await server.destroy();
    * ```
    * @example
    * This example creates a WsServer, and listens to changes to the clients
@@ -375,16 +375,16 @@ export interface WsServer {
    * );
    * // -> '1 client(s) in roomB'
    *
-   * synchronizer1.destroy();
+   * await synchronizer1.destroy();
    * // ...
    * // -> '0 client(s) in roomA'
    *
-   * synchronizer2.destroy();
+   * await synchronizer2.destroy();
    * // ...
    * // -> '0 client(s) in roomB'
    *
    * server.delListener(listenerId);
-   * server.destroy();
+   * await server.destroy();
    * ```
    * @category Listener
    * @since v5.0.0
@@ -420,11 +420,11 @@ export interface WsServer {
    *
    * server.delListener(listenerId);
    *
-   * synchronizer.destroy();
+   * await synchronizer.destroy();
    * // -> undefined
    * // The listener is not called.
    *
-   * server.destroy();
+   * await server.destroy();
    * ```
    * @category Listener
    * @since v5.0.0
@@ -461,9 +461,9 @@ export interface WsServer {
    * console.log(server.getStats());
    * // -> {paths: 1, clients: 2}
    *
-   * synchronizer1.destroy();
-   * synchronizer2.destroy();
-   * server.destroy();
+   * await synchronizer1.destroy();
+   * await synchronizer2.destroy();
+   * await server.destroy();
    * ```
    * @category Development
    * @since v5.0.0
@@ -474,7 +474,7 @@ export interface WsServer {
    * use.
    *
    * This closes the underlying WebSocketServer that was provided when the
-   * WsServer was created.
+   * WsServer was created. This method is asynchronous.
    * @example
    * This example creates a WsServer and then destroys it again, closing the
    * underlying WebSocketServer.
@@ -489,14 +489,14 @@ export interface WsServer {
    * });
    * const server = createWsServer(webSocketServer);
    *
-   * server.destroy();
+   * await server.destroy();
    * // ...
    * // -> 'WebSocketServer closed'
    * ```
    * @category Getter
    * @since v5.0.0
    */
-  destroy(): void;
+  destroy(): Promise<void>;
 }
 
 /**
@@ -595,9 +595,9 @@ export interface WsServer {
  * console.log(clientStore2.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * synchronizer1.destroy();
- * synchronizer2.destroy();
- * server.destroy();
+ * await synchronizer1.destroy();
+ * await synchronizer2.destroy();
+ * await server.destroy();
  * ```
  * @example
  * This longer example creates a WsServer that persists a MergeableStore to file
@@ -648,8 +648,8 @@ export interface WsServer {
  * console.log(clientStore2.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * synchronizer1.destroy();
- * synchronizer2.destroy();
+ * await synchronizer1.destroy();
+ * await synchronizer2.destroy();
  *
  * // ...
  * // Client 3 connects later
@@ -664,8 +664,8 @@ export interface WsServer {
  * console.log(clientStore3.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * synchronizer3.destroy();
- * server.destroy();
+ * await synchronizer3.destroy();
+ * await server.destroy();
  *
  * // Remove file for the purposes of this demo.
  * rmSync('petShop.json');
@@ -707,8 +707,8 @@ export interface WsServer {
  * console.log(clientStore.getContent());
  * // -> [{pets: {fido: {species: 'dog'}}}, {"pathId": "petShop"}]
  *
- * synchronizer.destroy();
- * server.destroy();
+ * await synchronizer.destroy();
+ * await server.destroy();
  *
  * // Remove file for the purposes of this demo.
  * rmSync('petShop.json');
@@ -739,8 +739,8 @@ export interface WsServer {
  * );
  * // -> 'Local client connected'
  *
- * synchronizer.destroy();
- * server.destroy();
+ * await synchronizer.destroy();
+ * await server.destroy();
  * ```
  * @category Creation
  * @since v5.0.0

package/@types/synchronizers/synchronizer-ws-server-simple/index.d.ts

@@ -44,7 +44,7 @@ export interface WsServerSimple {
    * console.log(server.getWebSocketServer() == webSocketServer);
    * // -> true
    *
-   * server.destroy();
+   * await server.destroy();
    * ```
    * @category Getter
    * @since v5.4.0
@@ -55,7 +55,7 @@ export interface WsServerSimple {
    * use.
    *
    * This closes the underlying WebSocketServer that was provided when the
-   * WsServerSimple was created.
+   * WsServerSimple was created. This method is asynchronous.
    * @example
    * This example creates a WsServerSimple and then destroys it again, closing
    * the underlying WebSocketServer.
@@ -70,14 +70,14 @@ export interface WsServerSimple {
    * });
    * const server = createWsServerSimple(webSocketServer);
    *
-   * server.destroy();
+   * await server.destroy();
    * // ...
    * // -> 'WebSocketServer closed'
    * ```
    * @category Getter
    * @since v5.4.0
    */
-  destroy(): void;
+  destroy(): Promise<void>;
 }
 
 /**
@@ -132,9 +132,9 @@ export interface WsServerSimple {
  * console.log(clientStore2.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * synchronizer1.destroy();
- * synchronizer2.destroy();
- * server.destroy();
+ * await synchronizer1.destroy();
+ * await synchronizer2.destroy();
+ * await server.destroy();
  * ```
  * @category Creation
  * @since v5.4.0

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

@@ -44,7 +44,7 @@ export interface WsServerSimple {
    * console.log(server.getWebSocketServer() == webSocketServer);
    * // -> true
    *
-   * server.destroy();
+   * await server.destroy();
    * ```
    * @category Getter
    * @since v5.4.0
@@ -55,7 +55,7 @@ export interface WsServerSimple {
    * use.
    *
    * This closes the underlying WebSocketServer that was provided when the
-   * WsServerSimple was created.
+   * WsServerSimple was created. This method is asynchronous.
    * @example
    * This example creates a WsServerSimple and then destroys it again, closing
    * the underlying WebSocketServer.
@@ -70,14 +70,14 @@ export interface WsServerSimple {
    * });
    * const server = createWsServerSimple(webSocketServer);
    *
-   * server.destroy();
+   * await server.destroy();
    * // ...
    * // -> 'WebSocketServer closed'
    * ```
    * @category Getter
    * @since v5.4.0
    */
-  destroy(): void;
+  destroy(): Promise<void>;
 }
 
 /**
@@ -132,9 +132,9 @@ export interface WsServerSimple {
  * console.log(clientStore2.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * synchronizer1.destroy();
- * synchronizer2.destroy();
- * server.destroy();
+ * await synchronizer1.destroy();
+ * await synchronizer2.destroy();
+ * await server.destroy();
  * ```
  * @category Creation
  * @since v5.4.0

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

@@ -190,8 +190,8 @@ export type SynchronizerStats = {
  * console.log(store1.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * synchronizer1.destroy();
- * synchronizer2.destroy();
+ * await synchronizer1.destroy();
+ * await synchronizer2.destroy();
  * ```
  * @category Synchronizer
  * @since v5.0.0
@@ -246,8 +246,8 @@ export interface Synchronizer<Schemas extends OptionalSchemas>
    * console.log(store1.getTables());
    * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
    *
-   * synchronizer1.destroy();
-   * synchronizer2.destroy();
+   * await synchronizer1.destroy();
+   * await synchronizer2.destroy();
    * ```
    * @example
    * This example creates two empty MergeableStore objects, creates a
@@ -277,8 +277,8 @@ export interface Synchronizer<Schemas extends OptionalSchemas>
    * console.log(store2.getTables());
    * // -> {pets: {fido: {species: 'dog'}}}
    *
-   * synchronizer1.destroy();
-   * synchronizer2.destroy();
+   * await synchronizer1.destroy();
+   * await synchronizer2.destroy();
    * ```
    * @category Synchronization
    * @since v5.0.0
@@ -292,7 +292,9 @@ export interface Synchronizer<Schemas extends OptionalSchemas>
    * Persister framework, and so this startSync method is equivalent to stopping
    * both auto-loading (listening to sync messages from other active
    * Synchronizer instances) and auto-saving (sending sync messages to them).
-   * @returns A reference to the Synchronizer object.
+   *
+   * This method is asynchronous.
+   * @returns A Promise containing a reference to the Synchronizer object.
    * @example
    * This example creates two empty MergeableStore objects, creates a
    * LocalSynchronizer for each, and starts - then stops - synchronizing them.
@@ -317,8 +319,8 @@ export interface Synchronizer<Schemas extends OptionalSchemas>
    * console.log(store2.getTables());
    * // -> {pets: {fido: {species: 'dog'}}}
    *
-   * synchronizer1.stopSync();
-   * synchronizer2.stopSync();
+   * await synchronizer1.stopSync();
+   * await synchronizer2.stopSync();
    *
    * store1.setCell('pets', 'fido', 'color', 'brown');
    * // ...
@@ -327,13 +329,13 @@ export interface Synchronizer<Schemas extends OptionalSchemas>
    * console.log(store2.getTables());
    * // -> {pets: {fido: {species: 'dog'}}}
    *
-   * synchronizer1.destroy();
-   * synchronizer2.destroy();
+   * await synchronizer1.destroy();
+   * await synchronizer2.destroy();
    * ```
    * @category Synchronization
    * @since v5.0.0
    */
-  stopSync(): this;
+  stopSync(): Promise<this>;
   /**
    * The getSynchronizerStats method provides a set of statistics about the
    * Synchronizer, and is used for debugging purposes.
@@ -372,8 +374,8 @@ export interface Synchronizer<Schemas extends OptionalSchemas>
    * console.log(synchronizer2.getSynchronizerStats());
    * // -> {receives: 5, sends: 4}
    *
-   * synchronizer1.destroy();
-   * synchronizer2.destroy();
+   * await synchronizer1.destroy();
+   * await synchronizer2.destroy();
    * ```
    * @category Synchronization
    * @since v5.0.0
@@ -485,8 +487,8 @@ export interface Synchronizer<Schemas extends OptionalSchemas>
  * console.log(store2.getTables());
  * // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
  *
- * synchronizer1.destroy();
- * synchronizer2.destroy();
+ * await synchronizer1.destroy();
+ * await synchronizer2.destroy();
  * ```
  * @category Creation
  * @since v5.0.0

package/@types/ui-react/index.d.ts

@@ -12110,8 +12110,8 @@ export function usePersisterStatusListener(
  * root.unmount(); // !act
  * // -> 'Synchronizer destroyed for ws://localhost:8045/'
  *
- * server1.destroy();
- * server2.destroy();
+ * await server1.destroy();
+ * await server2.destroy();
  * ```
  * @category Synchronizer hooks
  * @since v5.0.0