tinybase 5.4.0-beta.3 → 5.4.0-beta.5

package/@types/mergeable-store/index.d.cts

@@ -1018,13 +1018,14 @@ export interface MergeableStore extends Store {
   merge(mergeableStore: MergeableStore): MergeableStore;
 
   /**
-   * The isMergeable methods lets you know if the Store is mergeable.
+   * The isMergeable method lets you know if the Store is mergeable.
    *
-   * This will always be false for a Store, and true for a MergeableStore.
-   * @category Information
+   * This will always return false for a Store, and true for a MergeableStore.
+   * @returns Whether the Store is mergeable.
+   * @category Getter
    * @since v5.0.0
    */
-  isMergeable: () => boolean;
+  isMergeable(): boolean;
 }
 
 /**

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

@@ -1018,13 +1018,14 @@ export interface MergeableStore extends Store {
   merge(mergeableStore: MergeableStore): MergeableStore;
 
   /**
-   * The isMergeable methods lets you know if the Store is mergeable.
+   * The isMergeable method lets you know if the Store is mergeable.
    *
-   * This will always be false for a Store, and true for a MergeableStore.
-   * @category Information
+   * This will always return false for a Store, and true for a MergeableStore.
+   * @returns Whether the Store is mergeable.
+   * @category Getter
    * @since v5.0.0
    */
-  isMergeable: () => boolean;
+  isMergeable(): boolean;
 }
 
 /**

package/@types/mergeable-store/with-schemas/index.d.cts

@@ -1283,13 +1283,14 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
   merge(mergeableStore: MergeableStore<Schemas>): MergeableStore<Schemas>;
 
   /**
-   * The isMergeable methods lets you know if the Store is mergeable.
+   * The isMergeable method lets you know if the Store is mergeable.
    *
-   * This will always be false for a Store, and true for a MergeableStore.
-   * @category Information
+   * This will always return false for a Store, and true for a MergeableStore.
+   * @returns Whether the Store is mergeable.
+   * @category Getter
    * @since v5.0.0
    */
-  isMergeable: () => boolean;
+  isMergeable(): boolean;
 
   /**
    * The setTablesSchema method lets you specify the TablesSchema of the tabular

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

@@ -1283,13 +1283,14 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
   merge(mergeableStore: MergeableStore<Schemas>): MergeableStore<Schemas>;
 
   /**
-   * The isMergeable methods lets you know if the Store is mergeable.
+   * The isMergeable method lets you know if the Store is mergeable.
    *
-   * This will always be false for a Store, and true for a MergeableStore.
-   * @category Information
+   * This will always return false for a Store, and true for a MergeableStore.
+   * @returns Whether the Store is mergeable.
+   * @category Getter
    * @since v5.0.0
    */
-  isMergeable: () => boolean;
+  isMergeable(): boolean;
 
   /**
    * The setTablesSchema method lets you specify the TablesSchema of the tabular

package/@types/persisters/index.d.cts

@@ -1460,6 +1460,7 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * the underlying Store and storage are removed and it can be correctly
    * garbage collected. It is equivalent to running the stopAutoLoad method and
    * the stopAutoSave method in succession.
+   * @returns A reference to the Persister object.
    * @example
    * This example creates a Store, associates a Persister object with it (that
    * registers a TablesListener with the underlying Store), and then destroys it

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

@@ -1460,6 +1460,7 @@ export interface Persister<Persist extends Persists = Persists.StoreOnly> {
    * the underlying Store and storage are removed and it can be correctly
    * garbage collected. It is equivalent to running the stopAutoLoad method and
    * the stopAutoSave method in succession.
+   * @returns A reference to the Persister object.
    * @example
    * This example creates a Store, associates a Persister object with it (that
    * registers a TablesListener with the underlying Store), and then destroys it

package/@types/persisters/persister-durable-object-storage/index.d.cts

@@ -37,18 +37,23 @@ export interface DurableObjectStoragePersister
    * then gets the storage reference back out again.
    *
    * ```js yolo
+   * import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
    * import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
    * import {createMergeableStore} from 'tinybase';
    *
-   * // Within the createPersister method of a WsServerDurableObject instance.
-   * const store = createMergeableStore().setTables();
-   * const persister = createDurableObjectStoragePersister(
-   *   store,
-   *   this.ctx.storage,
-   * );
+   * export class MyDurableObject extends WsServerDurableObject {
+   *   createPersister() {
+   *     const store = createMergeableStore();
+   *     const persister = createDurableObjectStoragePersister(
+   *       store,
+   *       this.ctx.storage,
+   *     );
+   *     console.log(persister.getStorage() == this.ctx.storage);
+   *     // -> true
    *
-   * console.log(persister.getStorage() == this.ctx.storage);
-   * // -> true
+   *     return persister;
+   *   }
+   * }
    * ```
    * @category Getter
    * @since v5.4.0
@@ -85,24 +90,27 @@ export interface DurableObjectStoragePersister
  * instance) and then gets the storage reference back out again.
  *
  * ```js yolo
+ * import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
  * import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
  * import {createMergeableStore} from 'tinybase';
  *
- * // Within the createPersister method of a WsServerDurableObject instance.
- * const store = createMergeableStore().setTables();
- * const persister = createDurableObjectStoragePersister(
- *   store,
- *   this.ctx.storage,
- * );
- *
- * return persister;
+ * export class MyDurableObject extends WsServerDurableObject {
+ *   createPersister() {
+ *     const store = createMergeableStore();
+ *     const persister = createDurableObjectStoragePersister(
+ *       store,
+ *       this.ctx.storage,
+ *     );
+ *     return persister;
+ *   }
+ * }
  * ```
  * @category Creation
  * @since v5.4.0
  */
 export function createDurableObjectStoragePersister(
   store: MergeableStore,
-  durableObjectStorage: DurableObjectStorage,
+  storage: DurableObjectStorage,
   storagePrefix?: string,
   onIgnoredError?: (error: any) => void,
 ): DurableObjectStoragePersister;

package/@types/persisters/persister-durable-object-storage/index.d.ts

@@ -37,18 +37,23 @@ export interface DurableObjectStoragePersister
    * then gets the storage reference back out again.
    *
    * ```js yolo
+   * import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
    * import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
    * import {createMergeableStore} from 'tinybase';
    *
-   * // Within the createPersister method of a WsServerDurableObject instance.
-   * const store = createMergeableStore().setTables();
-   * const persister = createDurableObjectStoragePersister(
-   *   store,
-   *   this.ctx.storage,
-   * );
+   * export class MyDurableObject extends WsServerDurableObject {
+   *   createPersister() {
+   *     const store = createMergeableStore();
+   *     const persister = createDurableObjectStoragePersister(
+   *       store,
+   *       this.ctx.storage,
+   *     );
+   *     console.log(persister.getStorage() == this.ctx.storage);
+   *     // -> true
    *
-   * console.log(persister.getStorage() == this.ctx.storage);
-   * // -> true
+   *     return persister;
+   *   }
+   * }
    * ```
    * @category Getter
    * @since v5.4.0
@@ -85,24 +90,27 @@ export interface DurableObjectStoragePersister
  * instance) and then gets the storage reference back out again.
  *
  * ```js yolo
+ * import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
  * import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
  * import {createMergeableStore} from 'tinybase';
  *
- * // Within the createPersister method of a WsServerDurableObject instance.
- * const store = createMergeableStore().setTables();
- * const persister = createDurableObjectStoragePersister(
- *   store,
- *   this.ctx.storage,
- * );
- *
- * return persister;
+ * export class MyDurableObject extends WsServerDurableObject {
+ *   createPersister() {
+ *     const store = createMergeableStore();
+ *     const persister = createDurableObjectStoragePersister(
+ *       store,
+ *       this.ctx.storage,
+ *     );
+ *     return persister;
+ *   }
+ * }
  * ```
  * @category Creation
  * @since v5.4.0
  */
 export function createDurableObjectStoragePersister(
   store: MergeableStore,
-  durableObjectStorage: DurableObjectStorage,
+  storage: DurableObjectStorage,
   storagePrefix?: string,
   onIgnoredError?: (error: any) => void,
 ): DurableObjectStoragePersister;

package/@types/persisters/persister-durable-object-storage/with-schemas/index.d.cts

@@ -38,18 +38,23 @@ export interface DurableObjectStoragePersister<Schemas extends OptionalSchemas>
    * then gets the storage reference back out again.
    *
    * ```js yolo
+   * import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
    * import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
    * import {createMergeableStore} from 'tinybase';
    *
-   * // Within the createPersister method of a WsServerDurableObject instance.
-   * const store = createMergeableStore().setTables();
-   * const persister = createDurableObjectStoragePersister(
-   *   store,
-   *   this.ctx.storage,
-   * );
+   * export class MyDurableObject extends WsServerDurableObject {
+   *   createPersister() {
+   *     const store = createMergeableStore();
+   *     const persister = createDurableObjectStoragePersister(
+   *       store,
+   *       this.ctx.storage,
+   *     );
+   *     console.log(persister.getStorage() == this.ctx.storage);
+   *     // -> true
    *
-   * console.log(persister.getStorage() == this.ctx.storage);
-   * // -> true
+   *     return persister;
+   *   }
+   * }
    * ```
    * @category Getter
    * @since v5.4.0
@@ -67,7 +72,7 @@ export interface DurableObjectStoragePersister<Schemas extends OptionalSchemas>
  * ```ts override
  * createDurableObjectStoragePersister(
  *   store: MergeableStore,
- *   durableObjectStorage: DurableObjectStorage,
+ *   storage: DurableObjectStorage,
  *   storagePrefix?: string,
  *   onIgnoredError?: (error: any) => void,
  * ): DurableObjectStoragePersister;
@@ -97,17 +102,20 @@ export interface DurableObjectStoragePersister<Schemas extends OptionalSchemas>
  * instance) and then gets the storage reference back out again.
  *
  * ```js yolo
+ * import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
  * import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
  * import {createMergeableStore} from 'tinybase';
  *
- * // Within the createPersister method of a WsServerDurableObject instance.
- * const store = createMergeableStore().setTables();
- * const persister = createDurableObjectStoragePersister(
- *   store,
- *   this.ctx.storage,
- * );
- *
- * return persister;
+ * export class MyDurableObject extends WsServerDurableObject {
+ *   createPersister() {
+ *     const store = createMergeableStore();
+ *     const persister = createDurableObjectStoragePersister(
+ *       store,
+ *       this.ctx.storage,
+ *     );
+ *     return persister;
+ *   }
+ * }
  * ```
  * @category Creation
  * @since v5.4.0
@@ -116,7 +124,7 @@ export function createDurableObjectStoragePersister<
   Schemas extends OptionalSchemas,
 >(
   store: MergeableStore<Schemas>,
-  durableObjectStorage: DurableObjectStorage,
+  storage: DurableObjectStorage,
   storagePrefix?: string,
   onIgnoredError?: (error: any) => void,
 ): DurableObjectStoragePersister<Schemas>;

package/@types/persisters/persister-durable-object-storage/with-schemas/index.d.ts

@@ -38,18 +38,23 @@ export interface DurableObjectStoragePersister<Schemas extends OptionalSchemas>
    * then gets the storage reference back out again.
    *
    * ```js yolo
+   * import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
    * import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
    * import {createMergeableStore} from 'tinybase';
    *
-   * // Within the createPersister method of a WsServerDurableObject instance.
-   * const store = createMergeableStore().setTables();
-   * const persister = createDurableObjectStoragePersister(
-   *   store,
-   *   this.ctx.storage,
-   * );
+   * export class MyDurableObject extends WsServerDurableObject {
+   *   createPersister() {
+   *     const store = createMergeableStore();
+   *     const persister = createDurableObjectStoragePersister(
+   *       store,
+   *       this.ctx.storage,
+   *     );
+   *     console.log(persister.getStorage() == this.ctx.storage);
+   *     // -> true
    *
-   * console.log(persister.getStorage() == this.ctx.storage);
-   * // -> true
+   *     return persister;
+   *   }
+   * }
    * ```
    * @category Getter
    * @since v5.4.0
@@ -67,7 +72,7 @@ export interface DurableObjectStoragePersister<Schemas extends OptionalSchemas>
  * ```ts override
  * createDurableObjectStoragePersister(
  *   store: MergeableStore,
- *   durableObjectStorage: DurableObjectStorage,
+ *   storage: DurableObjectStorage,
  *   storagePrefix?: string,
  *   onIgnoredError?: (error: any) => void,
  * ): DurableObjectStoragePersister;
@@ -97,17 +102,20 @@ export interface DurableObjectStoragePersister<Schemas extends OptionalSchemas>
  * instance) and then gets the storage reference back out again.
  *
  * ```js yolo
+ * import {WsServerDurableObject} from 'tinybase/synchronizers/synchronizer-ws-server-durable-object';
  * import {createDurableObjectStoragePersister} from 'tinybase/persisters/persister-durable-object-storage';
  * import {createMergeableStore} from 'tinybase';
  *
- * // Within the createPersister method of a WsServerDurableObject instance.
- * const store = createMergeableStore().setTables();
- * const persister = createDurableObjectStoragePersister(
- *   store,
- *   this.ctx.storage,
- * );
- *
- * return persister;
+ * export class MyDurableObject extends WsServerDurableObject {
+ *   createPersister() {
+ *     const store = createMergeableStore();
+ *     const persister = createDurableObjectStoragePersister(
+ *       store,
+ *       this.ctx.storage,
+ *     );
+ *     return persister;
+ *   }
+ * }
  * ```
  * @category Creation
  * @since v5.4.0
@@ -116,7 +124,7 @@ export function createDurableObjectStoragePersister<
   Schemas extends OptionalSchemas,
 >(
   store: MergeableStore<Schemas>,
-  durableObjectStorage: DurableObjectStorage,
+  storage: DurableObjectStorage,
   storagePrefix?: string,
   onIgnoredError?: (error: any) => void,
 ): DurableObjectStoragePersister<Schemas>;

package/@types/persisters/persister-partykit-server/index.d.cts

@@ -163,10 +163,12 @@ export type TinyBasePartyKitServerConfig = {
 export class TinyBasePartyKitServer implements Server {
   /**
    * The constructor is used to create the server.
+   * @returns A new instance of the TinyBasePartyKitServer.
    * @category Creation
    * @since v4.3.9
    */
   constructor(party: Party);
+
   /**
    * The config property is used to optionally configure the server, using an
    * object of the TinyBasePartyKitServerConfig type.
@@ -176,6 +178,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.9
    */
   readonly config: TinyBasePartyKitServerConfig;
+
   /**
    * The onRequest method is called when a HTTP request is made to the party
    * URL.
@@ -202,6 +205,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.0
    */
   onRequest(request: Request): Promise<Response>;
+
   /**
    * The onMessage method is called when the server receives a message from a
    * client.
@@ -228,6 +232,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.0
    */
   onMessage(message: string, connection: Connection): Promise<void>;
+
   /**
    * The canSetTable method lets you allow or disallow any changes to a Table
    * stored on the server, as sent from a client.
@@ -276,6 +281,7 @@ export class TinyBasePartyKitServer implements Server {
     initialSave: boolean,
     requestOrConnection: Request | Connection,
   ): Promise<boolean>;
+
   /**
    * The canDelTable method lets you allow or disallow deletions of a Table
    * stored on the server, as sent from a client.
@@ -310,6 +316,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.12
    */
   canDelTable(tableId: Id, connection: Connection): Promise<boolean>;
+
   /**
    * The canSetRow method lets you allow or disallow any changes to a Row stored
    * on the server, as sent from a client.
@@ -355,6 +362,7 @@ export class TinyBasePartyKitServer implements Server {
     initialSave: boolean,
     requestOrConnection: Request | Connection,
   ): Promise<boolean>;
+
   /**
    * The canDelRow method lets you allow or disallow deletions of a Row stored
    * on the server, as sent from a client.
@@ -390,6 +398,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.12
    */
   canDelRow(tableId: Id, rowId: Id, connection: Connection): Promise<boolean>;
+
   /**
    * The canSetCell method lets you allow or disallow any changes to a Cell
    * stored on the server, as sent from a client.
@@ -441,6 +450,7 @@ export class TinyBasePartyKitServer implements Server {
     requestOrConnection: Request | Connection,
     oldCell: CellOrUndefined,
   ): Promise<boolean>;
+
   /**
    * The canDelCell method lets you allow or disallow deletions of a Cell stored
    * on the server, as sent from a client.
@@ -481,6 +491,7 @@ export class TinyBasePartyKitServer implements Server {
     cellId: Id,
     connection: Connection,
   ): Promise<boolean>;
+
   /**
    * The canSetValue method lets you allow or disallow any changes to a Value
    * stored on the server, as sent from a client.
@@ -530,6 +541,7 @@ export class TinyBasePartyKitServer implements Server {
     requestOrConnection: Request | Connection,
     oldValue: ValueOrUndefined,
   ): Promise<boolean>;
+
   /**
    * The canDelValue method lets you allow or disallow deletions of a Value
    * stored on the server, as sent from a client.

package/@types/persisters/persister-partykit-server/index.d.ts

@@ -163,10 +163,12 @@ export type TinyBasePartyKitServerConfig = {
 export class TinyBasePartyKitServer implements Server {
   /**
    * The constructor is used to create the server.
+   * @returns A new instance of the TinyBasePartyKitServer.
    * @category Creation
    * @since v4.3.9
    */
   constructor(party: Party);
+
   /**
    * The config property is used to optionally configure the server, using an
    * object of the TinyBasePartyKitServerConfig type.
@@ -176,6 +178,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.9
    */
   readonly config: TinyBasePartyKitServerConfig;
+
   /**
    * The onRequest method is called when a HTTP request is made to the party
    * URL.
@@ -202,6 +205,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.0
    */
   onRequest(request: Request): Promise<Response>;
+
   /**
    * The onMessage method is called when the server receives a message from a
    * client.
@@ -228,6 +232,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.0
    */
   onMessage(message: string, connection: Connection): Promise<void>;
+
   /**
    * The canSetTable method lets you allow or disallow any changes to a Table
    * stored on the server, as sent from a client.
@@ -276,6 +281,7 @@ export class TinyBasePartyKitServer implements Server {
     initialSave: boolean,
     requestOrConnection: Request | Connection,
   ): Promise<boolean>;
+
   /**
    * The canDelTable method lets you allow or disallow deletions of a Table
    * stored on the server, as sent from a client.
@@ -310,6 +316,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.12
    */
   canDelTable(tableId: Id, connection: Connection): Promise<boolean>;
+
   /**
    * The canSetRow method lets you allow or disallow any changes to a Row stored
    * on the server, as sent from a client.
@@ -355,6 +362,7 @@ export class TinyBasePartyKitServer implements Server {
     initialSave: boolean,
     requestOrConnection: Request | Connection,
   ): Promise<boolean>;
+
   /**
    * The canDelRow method lets you allow or disallow deletions of a Row stored
    * on the server, as sent from a client.
@@ -390,6 +398,7 @@ export class TinyBasePartyKitServer implements Server {
    * @since v4.3.12
    */
   canDelRow(tableId: Id, rowId: Id, connection: Connection): Promise<boolean>;
+
   /**
    * The canSetCell method lets you allow or disallow any changes to a Cell
    * stored on the server, as sent from a client.
@@ -441,6 +450,7 @@ export class TinyBasePartyKitServer implements Server {
     requestOrConnection: Request | Connection,
     oldCell: CellOrUndefined,
   ): Promise<boolean>;
+
   /**
    * The canDelCell method lets you allow or disallow deletions of a Cell stored
    * on the server, as sent from a client.
@@ -481,6 +491,7 @@ export class TinyBasePartyKitServer implements Server {
     cellId: Id,
     connection: Connection,
   ): Promise<boolean>;
+
   /**
    * The canSetValue method lets you allow or disallow any changes to a Value
    * stored on the server, as sent from a client.
@@ -530,6 +541,7 @@ export class TinyBasePartyKitServer implements Server {
     requestOrConnection: Request | Connection,
     oldValue: ValueOrUndefined,
   ): Promise<boolean>;
+
   /**
    * The canDelValue method lets you allow or disallow deletions of a Value
    * stored on the server, as sent from a client.