@zenfs/core 0.0.7 → 0.0.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenfs/core",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "A filesystem in your browser",
   "main": "dist/index.js",
   "types": "dist",
@@ -44,19 +44,15 @@
   },
   "devDependencies": {
     "@jest/globals": "^29.5.0",
-    "@types/archiver": "~2.1.2",
     "@types/jest": "^29.5.1",
     "@types/node": "^14.18.62",
     "@typescript-eslint/eslint-plugin": "^5.55.0",
     "@typescript-eslint/parser": "^5.55.0",
-    "archiver": "~2.1.1",
     "buffer": "~5.1.0",
     "cross-env": "^7.0.3",
     "esbuild": "^0.17.18",
-    "esbuild-plugin-polyfill-node": "^0.3.0",
     "eslint": "^8.36.0",
     "jest": "^29.5.0",
-    "path": "^0.12.7",
     "prettier": "^2.8.7",
     "ts-jest": "^29.1.0",
     "typedoc": "^0.25.1",

package/{README.md → readme.md}

@@ -33,10 +33,10 @@ npm install @zenfs/core
 
 ## Usage
 
-> 🛈 The examples are written in ESM. If you are using CJS, you can `require` the package. If running in a borwser you can add a script tag to your HTML pointing to the `browser.min.js` and use ZenFS via the global `ZenFS` object.
+> 🛈 The examples are written in ESM. If you are using CJS, you can `require` the package. If running in a browser you can add a script tag to your HTML pointing to the `browser.min.js` and use ZenFS via the global `ZenFS` object.
 
 ```js
-import { fs } from '@zenfs/core';
+import fs from '@zenfs/core';
 
 fs.writeFileSync('/test.txt', 'Cool, I can do this in the browser!');
 
@@ -46,14 +46,15 @@ console.log(contents);
 
 #### Using different backends
 
-A `InMemory` backend is created by default. If you would like to use a different one, you must configure ZenFS. It is recommended to do so using the `configure` function. Here is an example using the `LocalStorage` backend from `@zenfs/fs-dom`:
+A `InMemory` backend is created by default. If you would like to use a different one, you must configure ZenFS. It is recommended to do so using the `configure` function. Here is an example using the `Storage` backend from `@zenfs/fs-dom`:
 
 ```js
-import { configure, fs } from '@zenfs/core';
-import '@zenfs/fs-dom'; // size effects are needed
+import { configure, fs, registerBackend } from '@zenfs/core';
+import { StorageFileSystem } from '@zenfs/fs-dom';
+registerBackend(StorageFileSystem);
 
 // you can also add a callback as the last parameter instead of using promises
-await configure({ fs: 'LocalStorage' });
+await configure({ fs: 'Storage' });
 
 if (!fs.existsSync('/test.txt')) {
 	fs.writeFileSync('/test.txt', 'This will persist across reloads!');
@@ -65,13 +66,14 @@ console.log(contents);
 
 #### Using multiple backends
 
-You can use multiple backends by passing an object to `configure` which maps paths to file systems. The following example mounts a zip file to `/zip`, in-memory storage to `/tmp`, and IndexedDB browser-local storage to `/home` (note that `/` has the default in-memory backend):
+You can use multiple backends by passing an object to `configure` which maps paths to file systems. The following example mounts a zip file to `/zip`, in-memory storage to `/tmp`, and IndexedDB storage to `/home` (note that `/` has the default in-memory backend):
 
 ```js
-import { configure } from '@zenfs/core';
-import '@zenfs/fs-dom';
-import '@zenfs/fs-zip';
+import { configure, registerBackend } from '@zenfs/core';
+import { IndexedDBFileSystem } from '@zenfs/fs-dom';
+import { ZipFS } from '@zenfs/fs-zip';
 import Buffer from 'buffer';
+registerBackend(IndexedDBFileSystem, ZipFS);
 
 const zipData = await (await fetch('mydata.zip')).arrayBuffer();
 
@@ -92,8 +94,9 @@ await configure({
 The FS promises API is exposed as `promises`.
 
 ```js
-import { configure, promises } from '@zenfs/core';
-import '@zenfs/fs-dom';
+import { configure, promises, registerBackend } from '@zenfs/core';
+import { IndexedDBFileSystem } from '@zenfs/fs-dom';
+registerBackend(IndexedDBFileSystem);
 
 await configure({ '/': 'IndexedDB' });
 
@@ -111,7 +114,8 @@ You may have noticed that attempting to use a synchronous method on an asynchron
 
 ```js
 import { configure, fs } from '@zenfs/core';
-import '@zenfs/fs-dom';
+import { IndexedDBFileSystem } from '@zenfs/fs-dom';
+registerBackend(IndexedDBFileSystem);
 
 await configure({
 	'/': { fs: 'AsyncMirror', options: { sync: { fs: 'InMemory' }, async: { fs: 'IndexedDB' } } }
@@ -161,10 +165,10 @@ fs.umount('/tmp'); // unmount /tmp
 This could be used in the "multiple backends" example like so:
 
 ```js
-import { configure, fs, ZipFS } from '@zenfs/core';
-import '@zenfs/fs-dom';
-import '@zenfs/fs-zip';
+import { IndexedDBFileSystem } from '@zenfs/fs-dom';
+import { ZipFS } from '@zenfs/fs-zip';
 import Buffer from 'buffer';
+registerBackend(IndexedDBFileSystem);
 
 await configure({
 	'/tmp': 'InMemory',
@@ -238,10 +242,10 @@ export default {
 You can use any _synchronous_ ZenFS file systems with Emscripten.
 
 ```js
-import { EmscriptenFS } from '@zenfs/fs-emscripten';
-const BFS = new EmscriptenFS(); // Create a ZenFS Emscripten FS plugin.
-FS.createFolder(FS.root, 'data', true, true); // Create the folder that we'll turn into a mount point.
-FS.mount(BFS, { root: '/' }, '/data'); // Mount BFS's root folder into the '/data' folder.
+import { EmscriptenFSPlugin } from '@zenfs/fs-emscripten';
+const BFS = new EmscriptenFSPlugin(); // Create a ZenFS Emscripten FS plugin.
+FS.createFolder(FS.root, 'data', true, true); // Create the folder to turn into a mount point.
+FS.mount(BFS, { root: '/' }, '/data'); // Mount BFS's root folder into /data.
 ```
 
 If you want to use an asynchronous backend, you must wrap it in an `AsyncMirror`.