[store] setContent can take a function

Author: jamesgpearce

src/@types/mergeable-store/docs.js

@@ -757,8 +757,11 @@
    * The method is generally intended to be used internally within TinyBase
    * itself and the return type is assumed to be opaque to applications that use
    * it.
+   *
+   * Since v5.4.2, this method can also take a function that returns the
+   * content.
    * @param content An array containing the tabular and keyed-value data to be
-   * set.
+   * set, or a function that returns the array.
    * @returns A reference to the MergeableStore.
    * @example
    * This example creates a new MergeableStore with default data, and

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

@@ -124,7 +124,7 @@ export interface MergeableStore extends Store {
   setMergeableContent(mergeableContent: MergeableContent): MergeableStore;
 
   /// MergeableStore.setDefaultContent
-  setDefaultContent(content: Content): MergeableStore;
+  setDefaultContent(content: Content | (() => Content)): MergeableStore;
 
   /// MergeableStore.getTransactionMergeableChanges
   getTransactionMergeableChanges(withHashes?: boolean): MergeableChanges<true>;

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

@@ -200,7 +200,9 @@ export interface MergeableStore<Schemas extends OptionalSchemas>
   ): MergeableStore<Schemas>;
 
   /// MergeableStore.setDefaultContent
-  setDefaultContent(content: Content<Schemas>): MergeableStore<Schemas>;
+  setDefaultContent(
+    content: Content<Schemas> | (() => Content<Schemas>),
+  ): MergeableStore<Schemas>;
 
   /// MergeableStore.getTransactionMergeableChanges
   getTransactionMergeableChanges(

src/@types/store/docs.js

@@ -2603,8 +2603,11 @@
    *
    * The method returns a reference to the Store so that subsequent operations
    * can be chained in a fluent style.
+   *
+   * Since v5.4.2, this method can also take a function that returns the
+   * content.
    * @param content An array containing the tabular and keyed-value data of the
-   * Store to be set.
+   * Store to be set, or a function that returns the array.
    * @returns A reference to the Store.
    * @example
    * This example sets the data of a Store.
@@ -2622,6 +2625,21 @@
    * // -> {open: true, employees: 3}
    * ```
    * @example
+   * This example sets the data of a Store with the results of a function.
+   *
+   * ```js
+   * import {createStore} from 'tinybase';
+   *
+   * const store = createStore().setContent(() => [
+   *   {pets: {fido: {species: 'dog'}}},
+   *   {open: true, employees: 3},
+   * ]);
+   * console.log(store.getTables());
+   * // -> {pets: {fido: {species: 'dog'}}}
+   * console.log(store.getValues());
+   * // -> {open: true, employees: 3}
+   * ```
+   * @example
    * This example attempts to set the data of an existing Store with partly
    * invalid, and then completely invalid objects.
    *

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

@@ -509,7 +509,7 @@ export interface Store {
   hasValuesSchema(): boolean;
 
   /// Store.setContent
-  setContent(content: Content): this;
+  setContent(content: Content | (() => Content)): this;
 
   /// Store.setTables
   setTables(tables: Tables): this;

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

@@ -1028,7 +1028,9 @@ export interface Store<in out Schemas extends OptionalSchemas> {
   hasValuesSchema(): boolean;
 
   /// Store.setContent
-  setContent(content: Content<Schemas, true>): this;
+  setContent(
+    content: Content<Schemas, true> | (() => Content<Schemas, true>),
+  ): this;
 
   /// Store.setTables
   setTables(tables: Tables<Schemas[0], true>): this;

src/mergeable-store/index.ts

@@ -526,7 +526,9 @@ export const createMergeableStore = ((uniqueId?: Id): MergeableStore => {
         : 0,
     );
 
-  const setDefaultContent = (content: Content): MergeableStore => {
+  const setDefaultContent = (
+    content: Content | (() => Content),
+  ): MergeableStore => {
     store.transaction(() => {
       defaultingContent = 1;
       store.setContent(content);

src/store/index.ts

@@ -1081,10 +1081,13 @@ export const createStore: typeof createStoreDecl = (): Store => {
   const getSchemaJson = (): Json =>
     jsonStringWithMap([tablesSchemaMap, valuesSchemaMap]);
 
-  const setContent = (content: Content): Store =>
-    fluentTransaction(() =>
-      validateContent(content) ? setValidContent(content) : 0,
-    );
+  const setContent = (content: Content | (() => Content)): Store =>
+    fluentTransaction(() => {
+      const content2 = isFunction(content) ? content() : content;
+      if (validateContent(content2)) {
+        setValidContent(content2);
+      }
+    });
 
   const setTables = (tables: Tables): Store =>
     fluentTransaction(() =>