Repository files navigation

@BrowserFS backends for DOM APIs.
DOM APIs areonly available natively in browsers.

BrowserFS is an in-browser file system that emulates theNode JS file system API and supports storing and retrieving files from various backends. BrowserFS also integrates nicely with other tools.

Packagessaoirse-iontach/browser-fs-dom#semver:0.1
depends onsaoirse-iontach/browser-fs-core#semver:0.1
which emulatenode:fsv14.x.x.

BrowserFS is a component of theDoppio andBrowsix research projects from the PLASMA lab at the University of Massachusetts Amherst. If you decide to use BrowserFS in a project that leads to a publication, please cite the academic papers onDoppio andBrowsix.

BrowserFS andZenFS are licensed under the MIT License. SeeLICENSE for details.

• HTTPRequest: Downloads files on-demand from a webserver usingfetch.
• Storage: Stores files in aStorage object, likelocalStorage andseesionStorage.
• IndexedDB: Stores files into anIndexedDB object database.
• WorkerFS: Lets you mount the BrowserFS file system configured in the main thread in a WebWorker, or the other way around!

For more information, see theAPI documentation.

npm install saoirse-iontach/browser-fs-dom# @browserfs/fs-dom

• Make sure you have Node and NPM installed. You must have Node v18 or newer.
• Install dependencies withnpm install
• Build usingnpm run build
• You can find the built code indist.

Run unit tests withnpm test.

🛈 The examples are written in ESM. If you are using CJS, you canrequire the package. If running in a browser you can add a script tag to your HTML pointing to thebrowser.min.js and use BrowserFS DOM via the globalBrowserFS_DOM object.

You can use DOM backends, though you must register them if you plan on usingconfigure:

import{configure,fs,registerBackend}from'@browserfs/core';import{Storage}from'@browserfs/fs-dom';registerBackend(Storage);awaitconfigure({fs:'Storage',options:{storage:localStorage}});if(!fs.existsSync('/test.txt')){fs.writeFileSync('/test.txt','This will persist across reloads!');}constcontents=fs.readFileSync('/test.txt','utf-8');console.log(contents);