57 lines
1.8 KiB
Markdown
57 lines
1.8 KiB
Markdown
|
# `@wasmer/wasmfs`
|
||
|
|
|
||
|
|
Isomorphic library to provide a sandboxed [node `fs`](https://nodejs.org/api/fs.html) implementation for Node and Browsers. 📂
|
||
|
|
|
||
|
|
Documentation for Wasmer-JS Stack can be found on the [Wasmer Docs](https://docs.wasmer.io/wasmer-js/wasmer-js).
|
||
|
|
|
||
|
|
## Table of Contents
|
||
|
|
|
||
|
|
- [Features](#features)
|
||
|
|
- [Installation](#installation)
|
||
|
|
- [Quick Start](#quick-start)
|
||
|
|
- [Reference API](#reference-api)
|
||
|
|
- [Contributing](#contributing)
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
This project heavily depends on [memfs](https://github.com/streamich/memfs) to provide the sandboxed `fs` implementation. 🙏😄
|
||
|
|
|
||
|
|
This package provides the following features:
|
||
|
|
|
||
|
|
- In-memory file-system with Node's fs API using [memfs](https://github.com/streamich/memfs). 🗄️
|
||
|
|
- Scaffolds common files used by the [Wasmer Runtime](https://github.com/wasmerio/wasmer) (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. 🛠️
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
For installing `@wasmer/wasmfs`, just run this command in your shell:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install --save @wasmer/wasmfs
|
||
|
|
```
|
||
|
|
|
||
|
|
## Quick Start
|
||
|
|
|
||
|
|
```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!'
|
||
|
|
});
|
||
|
|
```
|
||
|
|
|
||
|
|
## Reference API
|
||
|
|
|
||
|
|
The Reference API Documentation can be found on the [`@wasmer/wasmfs` Reference API Wasmer Docs](https://docs.wasmer.io/integrations/js/reference-api/wasmer-wasmfs).
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.
|
||
|
|
|
||
|
|
Contributions of any kind are welcome! 👍
|