https://github.com/streamich/memfs

JavaScript file system utilities
https://github.com/streamich/memfs

browserfs cas crud file filesystem fs fsa in-memory memfs memory node opfs webfs

Last synced: 21 days ago
JSON representation

JavaScript file system utilities

• Host: GitHub
• URL: https://github.com/streamich/memfs
• Owner: streamich
• License: apache-2.0
• Created: 2015-06-15T20:50:40.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-10T20:11:32.000Z (7 months ago)
• Last Synced: 2024-04-14T02:48:45.396Z (7 months ago)
• Topics: browserfs, cas, crud, file, filesystem, fs, fsa, in-memory, memfs, memory, node, opfs, webfs
• Language: TypeScript
• Homepage: https://onp4.com/@vadim/~memfs
• Size: 5.73 MB
• Stars: 1,606
• Watchers: 11
• Forks: 123
• Open Issues: 61
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-nodejs - memfs - In-memory filesystem with Node's API.  (Repository / Filesystem)
• awesome-list - memfs - memory filesystem with Node's API | streamich | 967 | (TypeScript)

README

        
# memfs

[![][chat-badge]][chat] [![][npm-badge]][npm-url]

[chat]: https://onp4.com/@vadim/~memfs

[chat-badge]: https://img.shields.io/badge/Chat-%F0%9F%92%AC-green?style=flat&logo=chat&link=https://onp4.com/@vadim/~memfs

[npm-url]: https://www.npmjs.com/package/memfs

[npm-badge]: https://img.shields.io/npm/v/memfs.svg

JavaScript file system utilities for Node.js and browser.

## Install

```shell

npm i memfs

```

## Resources

- Documentation

  - [In-memory Node.js `fs` API](./docs/node/index.md)

  - `experimental` [`fs` to File System Access API adapter](./docs/fsa/fs-to-fsa.md)

  - `experimental` [File System Access API to `fs` adapter](./docs/fsa/fsa-to-fs.md)

  - `experimental` [`crudfs` a CRUD-like file system abstraction](./docs/crudfs/index.md)

  - `experimental` [`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

- [Git in browser, which writes to a real folder](demo/git-fsa/README.md)

- [Git in browser, which writes to OPFS file system](demo/git-opfs/README.md)

- [Git on in-memory file system](demo/git/README.md)

- [`fs` in browser, creates a `.tar` file in real folder](demo/fsa-to-node-zipfile/README.md)

- [`fs` in browser, synchronous API, writes to real folder](demo/fsa-to-node-sync-tests/README.md)

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

## See also

- [`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

[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