@themartiancompany/fs

The Martian Company's Javascript File System Module (@themartiancompany/fs)

Platform-independent Javascript File System fs module, which dynamically loads either the platform's native fs module or the Origin Private File System (OPFS) module.

Installation

To build the Node module package from source run

$ make \
    all

A thmartiancompany-fs-<version>.tgz archive will be generated in the root of the repository.

To install the module system-wide run

# make \
    install-npm

To install it as a DogeOS system package from the Ur uncensorable user repository and application store run

ur \
  "nodejs-fs"

A mirror of the Ur universal recipe has been made available on The Martian Company's Github at nodejs-opfs-ur.

To download the library from the NPM Registry run

npm \
  install \
  --save \
    "@themartiancompany/opfs"

Documentation

For API documentation refer to the Happy OPFS, OPFS Tools and File System API.

Usage manual is located in man in reStructured text format and can be accessed upon module installation with

man \
  "tmcfs"

If you are looking for an example of how to write a full computer application composed of only Bash programs and Node modules but which runs the same and with zero modifications regardless of whether it has available for display a terminal or a browser window, you can look at the Ahsi program, written using the Crash Javascript and Crash Bash libraries.

Refer to the Ahsi repository for more information about installing and running it.

License

This software repository is released under the terms of the GNU Affero General Public License version 3.