@aleung/fs-monkey

Monkey patches for file system related things.

Usage no npm install needed!

<script type="module">
  import aleungFsMonkey from 'https://cdn.skypack.dev/@aleung/fs-monkey';
</script>

README

fs-monkey

Note: This is a fork of streamich/fs-monkey. It holds my PRs and is published as npm module @aleung/fs-monkey.

Monkey-patches for filesystem related things.

  • Rewrite require function to load Node's modules from memory.
  • Or rewrite the whole fs filesystem module.

Install

npm install --save fs-monkey

Terms

An fs-like object is an object that implements methods of Node's filesystem API. It is denoted as vol:

let vol = {
    readFile: () => { /* ... */ },
    readFileSync: () => { /* ... */ },
    // etc...
}

Reference

  • patchFs - rewrites Node's filesystem module fs with fs-like object vol
  • patchRequire - rewrites require function, patches Node's module module to use a given fs-like object for module loading

License

Unlicense - public domain.