Wondering what’s next for npm?Check out our public roadmap! »

    @wasmer/wasmfs
    TypeScript icon, indicating that this package has built-in type declarations

    0.12.0 • Public • Published

    @wasmer/wasmfs

    Isomorphic library to provide a sandboxed node fs implementation for Node and Browsers. 📂

    Documentation for Wasmer-JS Stack can be found on the Wasmer Docs.

    Table of Contents

    Features

    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. 🛠️

    Installation

    For installing @wasmer/wasmfs, just run this command in your shell:

    npm install --save @wasmer/wasmfs

    Quick Start

    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.

    Contributing

    This project follows the all-contributors specification.

    Contributions of any kind are welcome! 👍

    Install

    npm i @wasmer/wasmfs

    DownloadsWeekly Downloads

    581

    Version

    0.12.0

    License

    MIT

    Unpacked Size

    438 kB

    Total Files

    21

    Last publish

    Collaborators

    • avatar