ADD RxStorage Filesystem Node

CHANGELOG.md

@@ -2,7 +2,7 @@
 # RxDB Changelog
 
 <!-- CHANGELOG NEWEST -->
-
+- ADD [Filesystem Node RxStorage](https://rxdb.info/rx-storage-filesystem-node.html)
 <!-- ADD new changes here! -->
 
 <!-- /CHANGELOG NEWEST -->

config/tsconfig.types.json

@@ -8,7 +8,9 @@
     "declarationMap": false,
     "stripInternal": true,
     "noEmit": false,
-    "types": []
+    "types": [
+      "node"
+    ]
   },
   "include": [
     "../src"

docs-src/SUMMARY.md

@@ -101,6 +101,7 @@
     * [RxStorage IndexedDB](./rx-storage-indexeddb.md)
     * [RxStorage OPFS](./rx-storage-opfs.md)
     * [RxStorage SQLite](./rx-storage-sqlite.md)
+    * [RxStorage Filesystem Node](./rx-storage-filesystem-node.md)
     * [RxStorage FoundationDB](./rx-storage-foundationdb.md)
     * [RxStorage Worker](./rx-storage-worker.md)
     * [RxStorage Shared Worker](./rx-storage-shared-worker.md)
@@ -134,7 +135,6 @@
 
 * [LeaderElection](./leader-election.md)
 
-
 * [Cleanup](./cleanup.md)
 
 * [Backup](./backup.md)

docs-src/rx-storage-filesystem-node.md

@@ -0,0 +1,34 @@
+# Filesystem Node RxStorage
+
+The Filesystem Node [RxStorage](./rx-storage.md) for RxDB is built on top of the [Node.js Filesystem API](https://nodejs.org/api/fs.html).
+It stores data in plain json/txt files like any "normal" database does. It is a bit faster compared to the [SQLite storage](./rx-storage-sqlite.md) and its setup is less complex.
+Using the same database folder in parallel with multiple Node.js processes is supported when you set `multiInstance: true` while creating the [RxDatabase](./rx-database.md).
+
+**NOTICE: The Filesystem Node RxStorage is part of [RxDB Premium](https://rxdb.info/premium.html)**
+
+<p align="center">
+  <img src="./files/rx-storage-performance-node.png" alt="RxStorage performance - Node.js" width="700" />
+</p>
+
+
+## Usage
+
+```ts
+import {
+    createRxDatabase
+} from 'rxdb';
+import { getRxStorageFilesystemNode } from 'rxdb-premium/plugins/storage-filesystem-node';
+
+const myRxDatabase = await createRxDatabase({
+    name: 'exampledb',
+    storage: getRxStorageFilesystemNode({
+        basePath: path.join(__dirname, 'my-database-folder'),
+        /**
+         * Set inWorker=true if you use this RxStorage
+         * together with the WebWorker plugin.
+         */
+        inWorker: false
+    })
+});
+/* ... */
+```

docs-src/rx-storage.md

@@ -38,7 +38,12 @@ The OPFS `RxStorage` is based on the File System Access API. This has the best p
 
 ### SQLite [[premium](https://rxdb.info/premium.html)]
 
-The SQLite storage has the best performance when RxDB is used on **Node.js**, **Electron**, **React Native**, **Cordova** or **Capacitor**. [Read more](./rx-storage-sqlite.md)
+The SQLite storage has great performance when RxDB is used on **Node.js**, **Electron**, **React Native**, **Cordova** or **Capacitor**. [Read more](./rx-storage-sqlite.md)
+
+### Filesystem Node [[premium](https://rxdb.info/premium.html)]
+
+The Filesystem Node storage is best suited when you use RxDB in a Node.js process or with [electron.js](./electron.md). [Read more](./rx-storage-filesystem-node.md)
+
 
 ### FoundationDB
 

src/index.ts

@@ -161,6 +161,7 @@ export type {
     WithAttachmentsData,
     RxTestStorage,
     ById,
+    MaybePromise,
     RxQueryPlan,
     PlainJsonError,
     CompressionMode