ZenFS

The Node.js filesystem API, anywhere. Browsers included.

import { fs } from '@zenfs/core';

fs.writeFileSync('/test.txt', 'You can do this anywhere, including browsers!');

const contents = fs.readFileSync('/test.txt', 'utf-8');

Complete

ZenFS emulates the full surface of the latest Node.js fs API, including full type compatibility. Plus support for permissions.

Modular

A module backend system is used. You can mount a zip file, IndexedDB, S3, and memory side by side in one filesystem tree.

Performant

ZenFS runs just as fast as Node.js and is designed with a focus on performance. Every backend supports synchronous operations.

Extensible

Eaily add your own custom backends with minmal effort.

Packages

@zenfs/coreThe VFS, configuration, and built-in backends. Includes emulation of Node.js' fs, path, and readline.

@zenfs/domBackends built on DOM APIs. OPFS, IndexedDB, localStorage, and the DOM itself.

@zenfs/archivesRead-only backends for archive files. Currently supports .zip, .iso, and .tar.

@zenfs/cloudBackends for Dropbox, Google Drive, and S3.

@zenfs/emscriptenAn Emscripten backend, and an Emscripten plugin for the other direction.

@zenfs/linuxBest-effort Linux emulation: processes, /dev, /sys, /proc, and kernel modules.

Contribute Sponsor