💾 cofounder-node

What is the CoFounder and CoFounder-Node?

CoFounder is designed to offer file system functionalities within an abstraction layer.

This project is the 'node.js' implementation for CoFounder. It simply adapts node.js's fs, path, stream, child_process and etc. functionalities.

Plus, as a library, CoFounder-Node is completely tree-shanking-friendly. Your favorite module bundler can easily inline the functionality you need with no extra configuration, instead of bundling the whole CoFounder-Node package.

Quick start

Execute npm install cofounder-node to install CoFounder-Node and its dependencies into your project directory.

Usage

Basics

To initialize a Cofounder-Node instance:

import cofounder from 'cofounder-node';
// or const cofounder = require('cofounder-node').default;

cofounder.os.shell('ls');

List of methods

fs.cp
fs.cpP
fs.glob
fs.lstat
fs.mkdir
fs.mkdirP
fs.mv
fs.mvP
fs.readdir
fs.readFile
fs.rm
fs.rmdir
fs.rmdirP
fs.rmP
fs.writeFile
fs.writeFileP
json.loadFile
json.saveFile
os.shell

Todo List

See GitHub Projects for more.

Requirements

node.js (https://nodejs.org/)

License

Apache 2.0, for further details, please see LICENSE file

Contributing

See contributors.md

It is publicly open for any contribution. Bugfixes, new features and extra modules are welcome.

To contribute to code: Fork the repo, push your changes to your fork, and submit a pull request.
To report a bug: If something does not work, please report it using GitHub Issues.

To Support

Visit my patreon profile at patreon.com/eserozvataf

Package detail

cofounder-node

readme