tinybase 7.0.0-beta.1 → 7.0.0-beta.3

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

@@ -44,9 +44,9 @@ export type TablesSchema = {[tableId: Id]: {[cellId: Id]: CellSchema}};
  * The CellSchema type describes what values are allowed for each Cell in a
  * Table.
  *
- * A CellSchema specifies the type of the Cell (`string`, `boolean`, or
- * `number`), and what the default value can be when an explicit value is not
- * specified.
+ * A CellSchema specifies the type of the Cell (`string`, `boolean`, `number`;
+ * or `null`, since v7.0), and what the default value can be when an explicit
+ * value is not specified.
  *
  * If a default value is provided (and its type is correct), you can be certain
  * that that Cell will always be present in a Row.
@@ -70,9 +70,9 @@ export type TablesSchema = {[tableId: Id]: {[cellId: Id]: CellSchema}};
  * @since v1.0.0
  */
 export type CellSchema =
-  | {type: 'string'; default?: string}
-  | {type: 'number'; default?: number}
-  | {type: 'boolean'; default?: boolean};
+  | {type: 'string'; default?: string | null; allowNull?: boolean}
+  | {type: 'number'; default?: number | null; allowNull?: boolean}
+  | {type: 'boolean'; default?: boolean | null; allowNull?: boolean};
 
 /**
  * The ValuesSchema type describes the keyed Values that can be set in a Store
@@ -100,9 +100,9 @@ export type ValuesSchema = {[valueId: Id]: ValueSchema};
  * The ValueSchema type describes what values are allowed for keyed Values in a
  * Store.
  *
- * A ValueSchema specifies the type of the Value (`string`, `boolean`, or
- * `number`), and what the default value can be when an explicit value is not
- * specified.
+ * A ValueSchema specifies the type of the Value (`string`, `boolean`, `number`;
+ * or `null` since v7.0), and what the default value can be when an explicit
+ * value is not specified.
  *
  * If a default value is provided (and its type is correct), you can be certain
  * that the Value will always be present in a Store.
@@ -126,9 +126,9 @@ export type ValuesSchema = {[valueId: Id]: ValueSchema};
  * @since v3.0.0
  */
 export type ValueSchema =
-  | {type: 'string'; default?: string}
-  | {type: 'number'; default?: number}
-  | {type: 'boolean'; default?: boolean};
+  | {type: 'string'; default?: string | null; allowNull?: boolean}
+  | {type: 'number'; default?: number | null; allowNull?: boolean}
+  | {type: 'boolean'; default?: boolean | null; allowNull?: boolean};
 
 /**
  * The NoTablesSchema type is a TablesSchema-like type for when one has not been
@@ -280,7 +280,7 @@ export type Row = {[cellId: Id]: Cell};
  *
  * A Cell is used when setting a cell with the setCell method, and when getting
  * it back out again with the getCell method. A Cell is a JavaScript string,
- * number, or boolean.
+ * number, boolean; or null since v7.0.
  * @example
  * ```js
  * import type {Cell} from 'tinybase';
@@ -290,7 +290,7 @@ export type Row = {[cellId: Id]: Cell};
  * @category Store
  * @since v1.0.0
  */
-export type Cell = string | number | boolean;
+export type Cell = string | number | boolean | null;
 
 /**
  * The CellOrUndefined type is a data structure representing the data in a
@@ -329,7 +329,7 @@ export type Values = {[valueId: Id]: Value};
  *
  * A Value is used when setting a value with the setValue method, and when
  * getting it back out again with the getValue method. A Value is a JavaScript
- * string, number, or boolean.
+ * string, number, boolean; or null since v7.0.
  * @example
  * ```js
  * import type {Value} from 'tinybase';
@@ -339,7 +339,7 @@ export type Values = {[valueId: Id]: Value};
  * @category Store
  * @since v3.0.0
  */
-export type Value = string | number | boolean;
+export type Value = string | number | boolean | null;
 
 /**
  * The ValueOrUndefined type is a data structure representing the data in a
@@ -1704,13 +1704,14 @@ export type StoreListenerStats = {
  *
  * The keyed value support is best thought of as a flat JavaScript object. The
  * Store contains a number of Value objects, each with a unique ID, and which is
- * a string, boolean, or number.
+ * a string, boolean, number; or null since v7.0.
  *
  * ```json
  * {                  // Store
  *   "value1": "one",   // Value (string)
  *   "value2": true,    // Value (boolean)
  *   "value3": 3,       // Value (number)
+ *   "value4": null,    // Value (null since v7.0)
  *   ...
  * }
  * ```
@@ -1727,7 +1728,7 @@ export type StoreListenerStats = {
  * - Each Table contains a number of Row objects.
  * - Each Row contains a number of Cell objects.
  *
- * A Cell is a string, boolean, or number value.
+ * A Cell is a string, boolean, number; or null since v7.0.
  *
  * The members of each level of this hierarchy are identified with a unique Id
  * (which is a string). In other words you can naively think of a Store as a
@@ -1740,6 +1741,7 @@ export type StoreListenerStats = {
  *       "cell1": "one",       // Cell (string)
  *       "cell2": true,        // Cell (boolean)
  *       "cell3": 3,           // Cell (number)
+ *       "cell4": null,        // Cell (null since v7.0)
  *       ...
  *     },
  *     ...
@@ -1872,6 +1874,7 @@ export type StoreListenerStats = {
  * @see Hello World demos
  * @see Todo App demos
  * @category Store
+ * @essential Creating stores
  * @since v1.0.0
  */
 export interface Store {
@@ -2321,6 +2324,7 @@ export interface Store {
    * // -> {}
    * ```
    * @category Getter
+   * @essential Getting data
    * @since v1.0.0
    */
   getRow(tableId: Id, rowId: Id): Row;
@@ -2394,6 +2398,7 @@ export interface Store {
    * // -> undefined
    * ```
    * @category Getter
+   * @essential Getting data
    * @since v1.0.0
    */
   getCell(tableId: Id, rowId: Id, cellId: Id): CellOrUndefined;
@@ -2489,6 +2494,7 @@ export interface Store {
    * // -> undefined
    * ```
    * @category Getter
+   * @essential Getting data
    * @since v3.0.0
    */
   getValue(valueId: Id): ValueOrUndefined;
@@ -3157,6 +3163,7 @@ export interface Store {
    * // -> {pets: {fido: {color: 'brown'}}}
    * ```
    * @category Setter
+   * @essential Setting data
    * @since v1.0.0
    */
   setRow(tableId: Id, rowId: Id, row: Row): this;
@@ -3223,6 +3230,7 @@ export interface Store {
    * // -> {pets: {'0': {species: 'dog'}, '1': {species: 'cat'}}}
    * ```
    * @category Setter
+   * @essential Setting data
    * @since v1.0.0
    */
   addRow(tableId: Id, row: Row, reuseRowIds?: boolean): Id | undefined;
@@ -3343,6 +3351,7 @@ export interface Store {
    * // -> {pets: {fido: {species: 'dog'}}}
    * ```
    * @category Setter
+   * @essential Setting data
    * @since v1.0.0
    */
   setCell(tableId: Id, rowId: Id, cellId: Id, cell: Cell | MapCell): this;
@@ -3506,6 +3515,7 @@ export interface Store {
    * // -> {employees: 3}
    * ```
    * @category Setter
+   * @essential Setting data
    * @since v3.0.0
    */
   setValue(valueId: Id, value: Value | MapValue): this;
@@ -3539,7 +3549,7 @@ export interface Store {
    *   .setTables({pets: {fido: {species: 'dog', color: 'brown'}}})
    *   .setValues({open: true});
    *
-   * store.applyChanges([{pets: {fido: {color: 'black'}}}, {open: null}]);
+   * store.applyChanges([{pets: {fido: {color: 'black'}}}, {open: undefined}]);
    * console.log(store.getTables());
    * // -> {pets: {fido: {species: 'dog', color: 'black'}}}
    * console.log(store.getValues());
@@ -4263,6 +4273,7 @@ export interface Store {
    * // -> {open: true}
    * ```
    * @category Transaction
+   * @essential Setting data
    * @since v1.0.0
    */
   transaction<Return>(actions: () => Return, doRollback?: DoRollback): Return;
@@ -6025,6 +6036,7 @@ export interface Store {
    * store.delListener(listenerId);
    * ```
    * @category Listener
+   * @essential Listening for changes
    * @since v1.0.0
    */
   addRowListener(
@@ -6392,6 +6404,7 @@ export interface Store {
    * store.delListener(listenerId);
    * ```
    * @category Listener
+   * @essential Listening for changes
    * @since v1.0.0
    */
   addCellListener(
@@ -6794,6 +6807,7 @@ export interface Store {
    * store.delListener(listenerId);
    * ```
    * @category Listener
+   * @essential Listening for changes
    * @since v3.0.0
    */
   addValueListener(
@@ -7715,6 +7729,7 @@ export interface Store {
  * ```
  * @see The Basics guides
  * @category Creation
+ * @essential Creating stores
  * @since v1.0.0
  */
 export function createStore(): Store;

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

@@ -60,9 +60,9 @@ export type TablesSchema = {[tableId: Id]: {[cellId: Id]: CellSchema}};
  * The CellSchema type describes what values are allowed for each Cell in a
  * Table.
  *
- * A CellSchema specifies the type of the Cell (`string`, `boolean`, or
- * `number`), and what the default value can be when an explicit value is not
- * specified.
+ * A CellSchema specifies the type of the Cell (`string`, `boolean`, `number`;
+ * or `null`, since v7.0), and what the default value can be when an explicit
+ * value is not specified.
  *
  * If a default value is provided (and its type is correct), you can be certain
  * that that Cell will always be present in a Row.
@@ -116,9 +116,9 @@ export type ValuesSchema = {[valueId: Id]: ValueSchema};
  * The ValueSchema type describes what values are allowed for keyed Values in a
  * Store.
  *
- * A ValueSchema specifies the type of the Value (`string`, `boolean`, or
- * `number`), and what the default value can be when an explicit value is not
- * specified.
+ * A ValueSchema specifies the type of the Value (`string`, `boolean`, `number`;
+ * or `null` since v7.0), and what the default value can be when an explicit
+ * value is not specified.
  *
  * If a default value is provided (and its type is correct), you can be certain
  * that the Value will always be present in a Store.
@@ -361,12 +361,12 @@ export type Row<
  * This has schema-based typing. The following is a simplified representation:
  *
  * ```ts override
- * string | number | boolean;
+ * string | number | boolean | null;
  * ```
  *
  * A Cell is used when setting a cell with the setCell method, and when getting
  * it back out again with the getCell method. A Cell is a JavaScript string,
- * number, or boolean.
+ * number, boolean; or null since v7.0.
  * @example
  * ```js
  * import type {Cell} from 'tinybase';
@@ -463,12 +463,12 @@ export type Values<
  * This has schema-based typing. The following is a simplified representation:
  *
  * ```ts override
- * string | number | boolean;
+ * string | number | boolean | null;
  * ```
  *
  * A Value is used when setting a value with the setValue method, and when
  * getting it back out again with the getValue method. A Value is a JavaScript
- * string, number, or boolean.
+ * string, number, boolean; or null since v7.0.
  * @example
  * ```js
  * import type {Value} from 'tinybase';
@@ -2675,13 +2675,14 @@ export type StoreListenerStats = {
  *
  * The keyed value support is best thought of as a flat JavaScript object. The
  * Store contains a number of Value objects, each with a unique ID, and which is
- * a string, boolean, or number.
+ * a string, boolean, number; or null since v7.0.
  *
  * ```json
  * {                  // Store
  *   "value1": "one",   // Value (string)
  *   "value2": true,    // Value (boolean)
  *   "value3": 3,       // Value (number)
+ *   "value4": null,    // Value (null since v7.0)
  *   ...
  * }
  * ```
@@ -2698,7 +2699,7 @@ export type StoreListenerStats = {
  * - Each Table contains a number of Row objects.
  * - Each Row contains a number of Cell objects.
  *
- * A Cell is a string, boolean, or number value.
+ * A Cell is a string, boolean, number; or null since v7.0.
  *
  * The members of each level of this hierarchy are identified with a unique Id
  * (which is a string). In other words you can naively think of a Store as a
@@ -2711,6 +2712,7 @@ export type StoreListenerStats = {
  *       "cell1": "one",       // Cell (string)
  *       "cell2": true,        // Cell (boolean)
  *       "cell3": 3,           // Cell (number)
+ *       "cell4": null,        // Cell (null since v7.0)
  *       ...
  *     },
  *     ...
@@ -2843,6 +2845,7 @@ export type StoreListenerStats = {
  * @see Hello World demos
  * @see Todo App demos
  * @category Store
+ * @essential Creating stores
  * @since v1.0.0
  */
 export interface Store<in out Schemas extends OptionalSchemas> {
@@ -3363,6 +3366,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> {}
    * ```
    * @category Getter
+   * @essential Getting data
    * @since v1.0.0
    */
   getRow<TableId extends TableIdFromSchema<Schemas[0]>>(
@@ -3454,6 +3458,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Getter
+   * @essential Getting data
    * @since v1.0.0
    */
   getCell<
@@ -3574,6 +3579,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> undefined
    * ```
    * @category Getter
+   * @essential Getting data
    * @since v3.0.0
    */
   getValue<ValueId extends ValueIdFromSchema<Schemas[1]>>(
@@ -4310,6 +4316,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> {pets: {fido: {color: 'brown'}}}
    * ```
    * @category Setter
+   * @essential Setting data
    * @since v1.0.0
    */
   setRow<TableId extends TableIdFromSchema<Schemas[0]>>(
@@ -4386,6 +4393,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> {pets: {'0': {species: 'dog'}, '1': {species: 'cat'}}}
    * ```
    * @category Setter
+   * @essential Setting data
    * @since v1.0.0
    */
   addRow<TableId extends TableIdFromSchema<Schemas[0]>>(
@@ -4526,6 +4534,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> {pets: {fido: {species: 'dog'}}}
    * ```
    * @category Setter
+   * @essential Setting data
    * @since v1.0.0
    */
   setCell<
@@ -4717,6 +4726,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> {employees: 3}
    * ```
    * @category Setter
+   * @essential Setting data
    * @since v3.0.0
    */
   setValue<ValueId extends ValueIdFromSchema<Schemas[1]>>(
@@ -4759,7 +4769,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    *   .setTables({pets: {fido: {species: 'dog', color: 'brown'}}})
    *   .setValues({open: true});
    *
-   * store.applyChanges([{pets: {fido: {color: 'black'}}}, {open: null}]);
+   * store.applyChanges([{pets: {fido: {color: 'black'}}}, {open: undefined}]);
    * console.log(store.getTables());
    * // -> {pets: {fido: {species: 'dog', color: 'black'}}}
    * console.log(store.getValues());
@@ -5572,6 +5582,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * // -> {open: true}
    * ```
    * @category Transaction
+   * @essential Setting data
    * @since v1.0.0
    */
   transaction<Return>(
@@ -7551,6 +7562,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
+   * @essential Listening for changes
    * @since v1.0.0
    */
   addRowListener<
@@ -7973,6 +7985,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
+   * @essential Listening for changes
    * @since v1.0.0
    */
   addCellListener<
@@ -8438,6 +8451,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
    * store.delListener(listenerId);
    * ```
    * @category Listener
+   * @essential Listening for changes
    * @since v3.0.0
    */
   addValueListener<ValueIdOrNull extends ValueIdFromSchema<Schemas[1]> | null>(
@@ -9408,6 +9422,7 @@ export interface Store<in out Schemas extends OptionalSchemas> {
  * ```
  * @see The Basics guides
  * @category Creation
+ * @essential Creating stores
  * @since v1.0.0
  */
 export function createStore(): Store<NoSchemas>;

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

@@ -198,6 +198,7 @@ export type SynchronizerStats = {
  * await synchronizer2.destroy();
  * ```
  * @category Synchronizer
+ * @essential Synchronizing stores
  * @since v5.0.0
  */
 export interface Synchronizer extends Persister<Persists.MergeableStoreOnly> {

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

@@ -24,8 +24,9 @@ import type {Receive, Send, Synchronizer} from '../../with-schemas/index.d.ts';
  * @category Synchronizer
  * @since v5.0.0
  */
-export interface BroadcastChannelSynchronizer<Schemas extends OptionalSchemas>
-  extends Synchronizer<Schemas> {
+export interface BroadcastChannelSynchronizer<
+  Schemas extends OptionalSchemas,
+> extends Synchronizer<Schemas> {
   /**
    * The getChannelName method returns the name of the channel being used for
    * synchronization.

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

@@ -35,8 +35,9 @@ import type {Receive, Send, Synchronizer} from '../../with-schemas/index.d.ts';
  * @category Synchronizer
  * @since v5.0.0
  */
-export interface LocalSynchronizer<Schemas extends OptionalSchemas>
-  extends Synchronizer<Schemas> {}
+export interface LocalSynchronizer<
+  Schemas extends OptionalSchemas,
+> extends Synchronizer<Schemas> {}
 
 /**
  * The createLocalSynchronizer function creates a LocalSynchronizer object that

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

@@ -38,8 +38,9 @@ export type WebSocketTypes = WebSocket | WsWebSocket;
  * @category Synchronizer
  * @since v5.0.0
  */
-export interface WsSynchronizer<WebSocketType extends WebSocketTypes>
-  extends Synchronizer {
+export interface WsSynchronizer<
+  WebSocketType extends WebSocketTypes,
+> extends Synchronizer {
   /**
    * The getWebSocket method returns a reference to the WebSocket being used for
    * synchronization.
@@ -148,6 +149,7 @@ export interface WsSynchronizer<WebSocketType extends WebSocketTypes>
  * await server.destroy();
  * ```
  * @category Creation
+ * @essential Synchronizing stores
  * @since v5.0.0
  */
 export function createWsSynchronizer<WebSocketType extends WebSocketTypes>(

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

@@ -164,6 +164,7 @@ export interface WsSynchronizer<
  * await server.destroy();
  * ```
  * @category Creation
+ * @essential Synchronizing stores
  * @since v5.0.0
  */
 export function createWsSynchronizer<

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

@@ -537,7 +537,7 @@ export interface WsServer {
  * import {createMergeableStore} from 'tinybase';
  * import {createWsSynchronizer} from 'tinybase/synchronizers/synchronizer-ws-client';
  * import {createWsServer} from 'tinybase/synchronizers/synchronizer-ws-server';
- * import {WebSocketServer} from 'ws';
+ * import {WebSocket, WebSocketServer} from 'ws';
  *
  * // Server
  * const server = createWsServer(new WebSocketServer({port: 8047}));
@@ -583,7 +583,7 @@ export interface WsServer {
  * import {createFilePersister} from 'tinybase/persisters/persister-file';
  * import {createWsSynchronizer} from 'tinybase/synchronizers/synchronizer-ws-client';
  * import {createWsServer} from 'tinybase/synchronizers/synchronizer-ws-server';
- * import {WebSocketServer} from 'ws';
+ * import {WebSocket, WebSocketServer} from 'ws';
  *
  * // Server
  * const server = createWsServer(
@@ -591,7 +591,7 @@ export interface WsServer {
  *   (pathId) =>
  *     createFilePersister(
  *       createMergeableStore(),
- *       pathId.replace(/[^a-zA-Z0-9]/g, '-') + '.json',
+ *       './tmp/' + pathId.replace(/[^a-zA-Z0-9]/g, '-') + '.json',
  *     ),
  * );
  *
@@ -641,7 +641,7 @@ export interface WsServer {
  * await server.destroy();
  *
  * // Remove file for the purposes of this demo.
- * rmSync('petShop.json');
+ * rmSync('./tmp/petShop.json');
  * ```
  * @example
  * This example creates a WsServer that persists a MergeableStore to file that
@@ -654,7 +654,7 @@ export interface WsServer {
  * import {createFilePersister} from 'tinybase/persisters/persister-file';
  * import {createWsSynchronizer} from 'tinybase/synchronizers/synchronizer-ws-client';
  * import {createWsServer} from 'tinybase/synchronizers/synchronizer-ws-server';
- * import {WebSocketServer} from 'ws';
+ * import {WebSocket, WebSocketServer} from 'ws';
  *
  * // Server
  * const server = createWsServer(
@@ -662,7 +662,7 @@ export interface WsServer {
  *   (pathId) => [
  *     createFilePersister(
  *       createMergeableStore(),
- *       pathId.replace(/[^a-zA-Z0-9]/g, '-') + '.json',
+ *       './tmp/' + pathId.replace(/[^a-zA-Z0-9]/g, '-') + '.json',
  *     ),
  *     (store) => store.setValue('pathId', pathId),
  *   ],
@@ -684,7 +684,7 @@ export interface WsServer {
  * await server.destroy();
  *
  * // Remove file for the purposes of this demo.
- * rmSync('petShop.json');
+ * rmSync('./tmp/petShop.json');
  * ```
  * @example
  * This example creates a WsServer with a custom listener that displays

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

@@ -564,7 +564,7 @@ export interface WsServer {
  * import {createMergeableStore} from 'tinybase';
  * import {createWsSynchronizer} from 'tinybase/synchronizers/synchronizer-ws-client';
  * import {createWsServer} from 'tinybase/synchronizers/synchronizer-ws-server';
- * import {WebSocketServer} from 'ws';
+ * import {WebSocket, WebSocketServer} from 'ws';
  *
  * // Server
  * const server = createWsServer(new WebSocketServer({port: 8047}));
@@ -610,7 +610,7 @@ export interface WsServer {
  * import {createFilePersister} from 'tinybase/persisters/persister-file';
  * import {createWsSynchronizer} from 'tinybase/synchronizers/synchronizer-ws-client';
  * import {createWsServer} from 'tinybase/synchronizers/synchronizer-ws-server';
- * import {WebSocketServer} from 'ws';
+ * import {WebSocket, WebSocketServer} from 'ws';
  *
  * // Server
  * const server = createWsServer(
@@ -618,7 +618,7 @@ export interface WsServer {
  *   (pathId) =>
  *     createFilePersister(
  *       createMergeableStore(),
- *       pathId.replace(/[^a-zA-Z0-9]/g, '-') + '.json',
+ *       './tmp/' + pathId.replace(/[^a-zA-Z0-9]/g, '-') + '.json',
  *     ),
  * );
  *
@@ -668,7 +668,7 @@ export interface WsServer {
  * await server.destroy();
  *
  * // Remove file for the purposes of this demo.
- * rmSync('petShop.json');
+ * rmSync('./tmp/petShop.json');
  * ```
  * @example
  * This example creates a WsServer that persists a MergeableStore to file that
@@ -681,7 +681,7 @@ export interface WsServer {
  * import {createFilePersister} from 'tinybase/persisters/persister-file';
  * import {createWsSynchronizer} from 'tinybase/synchronizers/synchronizer-ws-client';
  * import {createWsServer} from 'tinybase/synchronizers/synchronizer-ws-server';
- * import {WebSocketServer} from 'ws';
+ * import {WebSocket, WebSocketServer} from 'ws';
  *
  * // Server
  * const server = createWsServer(
@@ -689,7 +689,7 @@ export interface WsServer {
  *   (pathId) => [
  *     createFilePersister(
  *       createMergeableStore(),
- *       pathId.replace(/[^a-zA-Z0-9]/g, '-') + '.json',
+ *       './tmp/' + pathId.replace(/[^a-zA-Z0-9]/g, '-') + '.json',
  *     ),
  *     (store) => store.setValue('pathId', pathId),
  *   ],
@@ -711,7 +711,7 @@ export interface WsServer {
  * await server.destroy();
  *
  * // Remove file for the purposes of this demo.
- * rmSync('petShop.json');
+ * rmSync('./tmp/petShop.json');
  * ```
  * @example
  * This example creates a WsServer with a custom listener that displays

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

@@ -28,6 +28,7 @@ import type {Persister, Persists} from '../../persisters/index.d.ts';
  * TinyBase uses (the constructor, `fetch`, `webSocketMessage`, and
  * `webSocketClose`) if you further override them.
  * @category Creation
+ * @essential Synchronizing stores
  * @since v5.4.0
  */
 export class WsServerDurableObject<Env = unknown> extends DurableObject<Env> {

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

@@ -36,6 +36,7 @@ import type {
  * TinyBase uses (the constructor, `fetch`, `webSocketMessage`, and
  * `webSocketClose`) if you further override them.
  * @category Creation
+ * @essential Synchronizing stores
  * @since v5.4.0
  */
 export class WsServerDurableObject<

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

@@ -101,7 +101,7 @@ export interface WsServerSimple {
  * import {createMergeableStore} from 'tinybase';
  * import {createWsSynchronizer} from 'tinybase/synchronizers/synchronizer-ws-client';
  * import {createWsServerSimple} from 'tinybase/synchronizers/synchronizer-ws-server-simple';
- * import {WebSocketServer} from 'ws';
+ * import {WebSocket, WebSocketServer} from 'ws';
  *
  * // Server
  * const server = createWsServerSimple(new WebSocketServer({port: 8053}));

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

@@ -101,7 +101,7 @@ export interface WsServerSimple {
  * import {createMergeableStore} from 'tinybase';
  * import {createWsSynchronizer} from 'tinybase/synchronizers/synchronizer-ws-client';
  * import {createWsServerSimple} from 'tinybase/synchronizers/synchronizer-ws-server-simple';
- * import {WebSocketServer} from 'ws';
+ * import {WebSocket, WebSocketServer} from 'ws';
  *
  * // Server
  * const server = createWsServerSimple(new WebSocketServer({port: 8053}));

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

@@ -194,10 +194,12 @@ export type SynchronizerStats = {
  * await synchronizer2.destroy();
  * ```
  * @category Synchronizer
+ * @essential Synchronizing stores
  * @since v5.0.0
  */
-export interface Synchronizer<Schemas extends OptionalSchemas>
-  extends Persister<Schemas, Persists.MergeableStoreOnly> {
+export interface Synchronizer<
+  Schemas extends OptionalSchemas,
+> extends Persister<Schemas, Persists.MergeableStoreOnly> {
   /**
    * The startSync method is used to start the process of synchronization
    * between this instance and another matching Synchronizer.