cat-bookmarker/assets/node_modules/fs-monkey
Nat 96939b7aee
Clean up repo and update deps
2024-03-10 11:52:04 -07:00
..
docs/api Clean up repo and update deps 2024-03-10 11:52:04 -07:00
lib Clean up repo and update deps 2024-03-10 11:52:04 -07:00
CHANGELOG.md Clean up repo and update deps 2024-03-10 11:52:04 -07:00
LICENSE Clean up repo and update deps 2024-03-10 11:52:04 -07:00
README.md Clean up repo and update deps 2024-03-10 11:52:04 -07:00
package.json Clean up repo and update deps 2024-03-10 11:52:04 -07:00

README.md

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.