[docs] v4.2

Author: jamesgpearce

site/guides/03_schemas_and_persistence/4_persisting_data.md

@@ -20,6 +20,7 @@ databases, and across synchronization boundaries with CRDT frameworks.
 | ------------------------ | --------------------------- | ------------------------------------------------------------------------------------------------------ |
 | persister-browser        | createSessionPersister      | Browser session storage                                                                                |
 | persister-browser        | createLocalPersister        | Browser local storage                                                                                  |
+| persister-indexed-db     | createIndexedDbPersister    | Browser IndexedDB                                                                                      |
 | persister-remote         | createRemotePersister       | Remote server                                                                                          |
 | persister-file           | createFilePersister         | Local file (where possible)                                                                            |
 | persister-sqlite3        | createSqlite3Persister      | SQLite in Node, via [sqlite3](https://github.com/TryGhost/node-sqlite3)                                |

site/guides/10_releases.md

@@ -3,6 +3,40 @@
 This is a reverse chronological list of the major TinyBase releases, with
 highlighted features.
 
+## v4.2
+
+This release adds support for persisting TinyBase to a browser's IndexedDB
+storage. The API is the same as for all the other Persister APIs:
+
+```js
+const store = createStore()
+  .setTable('pets', {fido: {species: 'dog'}})
+  .setTable('species', {dog: {price: 5}})
+  .setValues({open: true});
+const indexedDbPersister = createIndexedDbPersister(store, 'petStore');
+
+await indexedDbPersister.save();
+// IndexedDB ->
+//   database petStore:
+//     objectStore t:
+//       object 0:
+//         k: "pets"
+//         v: {fido: {species: dog}}
+//       object 1:
+//         k: "species"
+//         v: {dog: {price: 5}}
+//     objectStore v:
+//       object 0:
+//         k: "open"
+//         v: true
+
+indexedDbPersister.destroy();
+```
+
+Note that it is not possible to reactively detect changes to a browser's
+IndexedDB storage. A polling technique is used to load underlying changes if you
+choose to 'autoLoad' your data into TinyBase.
+
 ## v4.1
 
 This release introduces the new ui-react-dom module. This provides pre-built
@@ -34,7 +68,7 @@ const App = ({store}) => (
   <SortedTableInHtmlTable tableId="pets" cellId="species" store={store} />
 );
 
-const store = createStore().setTables({
+store.setTables({
   pets: {
     fido: {species: 'dog'},
     felix: {species: 'cat'},
@@ -48,13 +82,13 @@ console.log(app.innerHTML);
 // ->
 `
 <table>
-  <thead>
-    <tr><th>Id</th><th class="sorted ascending">↑ species</th></tr>
-  </thead>
-  <tbody>
-    <tr><th>felix</th><td>cat</td></tr>
-    <tr><th>fido</th><td>dog</td></tr>
-  </tbody>
+ <thead>
+   <tr><th>Id</th><th class="sorted ascending">↑ species</th></tr>
+ </thead>
+ <tbody>
+   <tr><th>felix</th><td>cat</td></tr>
+   <tr><th>fido</th><td>dog</td></tr>
+ </tbody>
 </table>
 `;
 
@@ -122,21 +156,21 @@ for the 'pets' table:
 const sqlite3 = await sqlite3InitModule();
 const db = new sqlite3.oo1.DB(':memory:', 'c');
 store.setTables({pets: {fido: {species: 'dog'}}});
-const persister = createSqliteWasmPersister(store, sqlite3, db, {
+const sqlitePersister = createSqliteWasmPersister(store, sqlite3, db, {
   mode: 'tabular',
   tables: {load: {pets: 'pets'}, save: {pets: 'pets'}},
 });
 
-await persister.save();
+await sqlitePersister.save();
 console.log(db.exec('SELECT * FROM pets;', {rowMode: 'object'}));
 // -> [{_id: 'fido', species: 'dog'}]
 
 db.exec(`INSERT INTO pets (_id, species) VALUES ('felix', 'cat')`);
-await persister.load();
+await sqlitePersister.load();
 console.log(store.getTables());
 // -> {pets: {fido: {species: 'dog'}, felix: {species: 'cat'}}}
 
-persister.destroy();
+sqlitePersister.destroy();
 ```
 
 ### CRDT Frameworks

site/home/index.md

@@ -62,7 +62,7 @@
   </p>
 </section>
 
-<a id='new' href='/guides/releases/#v4-1'><em>NEW!</em> v4.1 release</a>
+<a id='new' href='/guides/releases/#v4-2'><em>NEW!</em> v4.2 release</a>
 
 ---
 

src/types/docs/persisters.js

@@ -13,6 +13,7 @@
  * |-|-|-|
  * |persister-browser|createSessionPersister|Browser session storage|
  * |persister-browser|createLocalPersister|Browser local storage|
+ * |persister-indexed-db|createIndexedDbPersister|Browser IndexedDB|
  * |persister-remote|createRemotePersister|Remote server|
  * |persister-file|createFilePersister|Local file (where possible)|
  * |persister-sqlite3|createSqlite3Persister|SQLite in Node, via [sqlite3](https://github.com/TryGhost/node-sqlite3)|

src/types/docs/persisters/persister-indexed-db.js

@@ -19,7 +19,7 @@
  * key-value data respectively, using 'k' and 'v' to store the key and value of
  * each entry, as shown in the example.
  *
- * Note that it is not possible to reactively detect changes to a browser
+ * Note that it is not possible to reactively detect changes to a browser's
  * IndexedDB. If you do choose to enable automatic loading for the Persister
  * (with the startAutoLoad method), it needs to poll the database for changes.
  * The `autoLoadIntervalSeconds` method is used to indicate how often to do
@@ -30,7 +30,7 @@
  * 'autoLoad' mode.
  * @param onIgnoredError An optional handler for the errors that the Persister
  * would otherwise ignore when trying to save or load data. This is suitable for
- * debugging persistence issues in a development environment, since v4.0.4.
+ * debugging persistence issues in a development environment.
  * @returns A reference to the new Persister object.
  * @example
  * This example creates a Persister object and persists the Store to the
@@ -39,24 +39,29 @@
  * ```js
  * const store =
  *   createStore()
- *     .setTables({pets: {fido: {species: 'dog'}}})
+ *     .setTable('pets', {fido: {species: 'dog'}})
+ *     .setTable('species', {dog: {price: 5}})
  *     .setValues({open: true});
  * const persister = createIndexedDbPersister(store, 'petStore');
  *
  * await persister.save();
- * // IndexedDB:
+ * // IndexedDB ->
  * //   database petStore:
  * //     objectStore t:
  * //       object 0:
- * //         k: pets
- * //         v: {"fido":{"species":"dog"}}}
+ * //         k: "pets"
+ * //         v: {fido: {species: dog}}
+ * //       object 1:
+ * //         k: "species"
+ * //         v: {dog: {price: 5}}
  * //     objectStore v:
  * //       object 0:
- * //         k: open
+ * //         k: "open"
  * //         v: true
  *
  * persister.destroy();
  * ```
  * @category Creation
+ * @since v4.2.0
  */
 /// createIndexedDbPersister