Merge pull request #91 from isomorphic-git/low-level-backends

add to change low level backend

Author: jcubic

README.md

@@ -69,8 +69,10 @@ Options object:
 | `lockDbName`    | string             | Customize the database name for the lock mutex                                                                                                                                             |
 | `lockStoreName` | string             | Customize the store name for the lock mutex                                                                                                                                                |
 | `defer`         | boolean = false    | If true, avoids mutex contention during initialization                                                                                                                                     |
+| `db`            | IDB                | Replacement for DB object that hold Filesystem data. It's low level replacement for `backend` option.  |
 | `backend`       | IBackend           | If present, none of the other arguments (except `defer`) have any effect, and instead of using the normal LightningFS stuff, LightningFS acts as a wrapper around the provided custom backend. |
 
+
 #### Advanced usage
 
 You can procrastinate initializing the FS object until later.
@@ -258,6 +260,17 @@ interface IBackend {
   deactivate?(): Awaited<void>; // called after fs has been idle for a while
   destroy?(): Awaited<void>; // called before hotswapping backends
 }
+
+interface IDB {
+  saveSuperblock(superblock): void;
+  loadSuperblock(): Awaited<Buffer>;
+  readFile(inode): Awaited<Buffer>;
+  writeFile(inode, data): Awaited<void>;
+  unlink(inode): Awaited<void>;
+  wipe(): void;
+  close(): void;
+}
+
 ```
 
 ## License

azure-pipelines.yml

@@ -2,12 +2,12 @@ jobs:
 - job: Linux
 
   pool:
-    vmImage: 'Ubuntu 16.04'
+    vmImage: 'Ubuntu 18.04'
 
   steps:
   - task: NodeTool@0
     inputs:
-      versionSpec: '10.x'
+      versionSpec: '12.x'
     displayName: 'Install Node.js'
 
   - script: npm ci

src/DefaultBackend.js

@@ -21,12 +21,13 @@ module.exports = class DefaultBackend {
     url,
     urlauto,
     fileDbName = name,
+    db = null,
     fileStoreName = name + "_files",
     lockDbName = name + "_lock",
     lockStoreName = name + "_lock",
   } = {}) {
     this._name = name
-    this._idb = new IdbBackend(fileDbName, fileStoreName);
+    this._idb = db || new IdbBackend(fileDbName, fileStoreName);
     this._mutex = navigator.locks ? new Mutex2(name) : new Mutex(lockDbName, lockStoreName);
     this._cache = new CacheFS(name);
     this._opts = { wipe, url };
@@ -118,6 +119,8 @@ module.exports = class DefaultBackend {
       }
       if (encoding === "utf8") {
         data = decode(data);
+      } else {
+        data.toString = () => decode(data);
       }
     }
     if (!stat) throw new ENOENT(filepath)