Isomorphic library to provide a sandboxed node fs implementation for Node and Browsers. 📂
npm install @wasmer/wasmfs@wasmer/wasmfsIsomorphic library to provide a sandboxed node fs implementation for Node and Browsers. 📂
Documentation for Wasmer-JS Stack can be found on the Wasmer Docs.
- Features
- Installation
- Quick Start
- Reference API
- Contributing
This project heavily depends on memfs to provide the sandboxed fs implementation. 🙏😄
This package provides the following features:
- In-memory file-system with Node's fs API using memfs. 🗄️
- Scaffolds common files used by the Wasmer Runtime (e.g I/O Device files like /dev/stdout), to provide a similar experience to the Wasmer Runtime. 🔌
- Provides convienence functions for grabbing Input / Output. ↔️
- Allows overriding read/write of individual files to allow for custom implementations. 🛠️
For installing @wasmer/wasmfs, just run this command in your shell:
``bash`
npm install --save @wasmer/wasmfs
`js
import { WasmFs } from "@wasmer/wasmfs";
const wasmFs = new WasmFs();
wasmFs.fs.writeFileSync("/dev/stdout", "Quick Start!");
wasmFs.getStdOut().then(response => {
console.log(response); // Would log: 'Quick Start!'
});
`
The Reference API Documentation can be found on the @wasmer/wasmfs` Reference API Wasmer Docs.
This project follows the all-contributors specification.
Contributions of any kind are welcome! 👍