fs-zoo/README.md

File system abstractions and implementations

# fs-zoo

JavaScript file system utilities for Node.js and browser.

## Install

```shell
npm i fs-zoo
```

## Resources

- [`crudfs` a CRUD-like file system abstraction](./docs/crudfs/index.md)
- [`casfs` Content Addressable Storage file system abstraction](./docs/casfs/index.md)
- [Directory `snapshot` utility](./docs/snapshot/index.md)
- [`print` directory tree to terminal](./docs/print/index.md)
- [Code reference](https://streamich.github.io/memfs/)
- [Test coverage](https://streamich.github.io/memfs/coverage/lcov-report/)

## Demos

- [`crudfs` and `casfs` in browser and Node.js interoperability](demo/crud-and-cas/README.md)

## See also

- [`memfs`][memfs] - creates an in-memory file system, with Node.js `fs` API
- [`unionfs`][unionfs] - creates a union of multiple filesystem volumes
- [`fs-monkey`][fs-monkey] - monkey-patches Node's `fs` module and `require` function
- [`linkfs`][linkfs] - redirects filesystem paths
- [`spyfs`][spyfs] - spies on filesystem actions

[memfs]: https://github.com/streamich/memfs
[unionfs]: https://github.com/streamich/unionfs
[fs-monkey]: https://github.com/streamich/fs-monkey
[linkfs]: https://github.com/streamich/linkfs
[spyfs]: https://github.com/streamich/spyfs

## License

Apache 2.0