@fireproof/core 0.5.0 → 0.5.2

package/README.md

@@ -139,6 +139,17 @@ Thanks to Alan Shaw and Mikeal Rogers without whom this project would have never
 
 # Contributing
 
+To contribute please follow these steps for local setup and installation of the project
+
+1. Click on the "Fork" button in the top-right corner of the repository's page. This will create a copy of the repository in your account.
+2. Clone the forked repository to your local machine using Git.
+3. Now cd to the target directory, or load the directory in your IDE, and open up a terminal.
+4. Write the command `pnpm install`. This will install all the dependencies that are listed in the `package.json` file.
+5. Now change the directory to packages/fireproof using the command `cd packages/fireproof`.
+6. See the `package.json` file to work with all the listed commands and try them out. You can also test your application locally using `npm test`.
+7. Also change directory to `examples/todomvc` and run the command `npm run dev` to load up a simple application to understand the use of Fireproof as a real-time database.
+8. Keep contributing :) See [projects](https://github.com/fireproof-storage/fireproof/projects?query=is%3Aopen) and [issues](https://github.com/fireproof-storage/fireproof/issues) for ideas where to get started.
+
 Feel free to join in. All welcome. [Open an issue](https://github.com/jchris/fireproof/issues)!
 
 # License

package/dist/src/fireproof.js

@@ -38697,11 +38697,13 @@ class DbIndex {
     if (!database.indexBlocks) {
       database.indexBlocks = new TransactionBlockstore(database?.name + '.indexes', database.blocks.valet?.getKeyMaterial());
     }
-    /**
-     * The map function to apply to each entry in the database.
-     * @type {Function}
-     */
-
+    if (typeof name === 'function') {
+      // app is using deprecated API, remove in 0.7
+      opts = clock || {};
+      clock = mapFn || null;
+      mapFn = name;
+      name = null;
+    }
     if (typeof mapFn === 'string') {
       this.mapFnString = mapFn;
     } else {