Backends

Installing

npm install @zenfs/core

Usage

Note

The examples are written in ESM.
If you are using CJS, you canrequire the package.
If using a browser environment without support fortype=module inscript tags, you can add ascript tag to your HTML pointing to thebrowser.min.js and use ZenFS with the globalZenFS object.

importfsfrom'@zenfs/core';// You can also use the named export, `fs`fs.writeFileSync('/test.txt','Cool, I can do this in any JS environment (including browsers)!');constcontents=fs.readFileSync('/test.txt','utf-8');console.log(contents);

Using different and/or multiple backends

import{configure,InMemory}from'@zenfs/core';import{IndexedDB}from'@zenfs/dom';import{Zip}from'@zenfs/zip';constres=awaitfetch('mydata.zip');awaitconfigure({mounts:{'/mnt/zip':{backend:Zip,data:awaitres.arrayBuffer()},'/tmp':InMemory,'/home':IndexedDB,}};

Tip

When configuring a mount point, you can pass in

1. ABackend object, if the backend has no required options
2. An object that has the options accepted by the backend and abackend property which is aBackend object
3. AFileSystem instance

import{configureSingle,fs}from'@zenfs/core';import{WebStorage}from'@zenfs/dom';awaitconfigureSingle({backend:WebStorage});if(!fs.existsSync('/test.txt')){fs.writeFileSync('/test.txt','This will persist across reloads!');}constcontents=fs.readFileSync('/test.txt','utf-8');console.log(contents);

FS Promises

import{configureSingle}from'@zenfs/core';import{exists,writeFile}from'@zenfs/core/promises';import{IndexedDB}from'@zenfs/dom';awaitconfigureSingle({backend:IndexedDB});constexists=awaitexists('/myfile.txt');if(!exists){awaitwriteFile('/myfile.txt','Lots of persistant data');}

Note

You can import the promises API using:

1. Exports from@zenfs/core/promises
2. Thepromises export from@zenfs/core
3. fs.promises on the exportedfs from@zenfs/core.

Mounting and unmounting, creating backends

import{configure,resolveMountConfig,InMemory}from'@zenfs/core';import{IndexedDB}from'@zenfs/dom';import{Zip}from'@zenfs/zip';awaitconfigure({mounts:{'/tmp':InMemory,'/home':IndexedDB,},});fs.mkdirSync('/mnt');constres=awaitfetch('mydata.zip');constzipfs=awaitresolveMountConfig({backend:Zip,data:awaitres.arrayBuffer()});fs.mount('/mnt/zip',zipfs);// do stuff with the mounted zipfs.umount('/mnt/zip');// finished using the zip

Warning

Instances of backends follow theinternal ZenFS API. You should never use a backend's methods unless you are extending a backend.

Using with bundlers

Building

Testing