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: 22 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 10 years ago)
- Default Branch: master
- Last Pushed: 2025-03-01T00:36:04.000Z (12 months ago)
- Last Synced: 2025-05-01T12:02:29.161Z (10 months ago)
- Topics: browserfs, cas, crud, file, filesystem, fs, fsa, in-memory, memfs, memory, node, opfs, webfs
- Language: TypeScript
- Homepage: http://streamich.github.io/memfs/
- Size: 6.55 MB
- Stars: 1,860
- Watchers: 11
- Forks: 133
- Open Issues: 70
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.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)
- stars - memfs - memory implementations 👍 | streamich | 2035 | (TypeScript)
- awesome-bookmarks - **memfs** - fs 的替代品，将文件放在内存中优化读写，webpack 依赖 (Node / 文件处理)
README
# memfs
[![][npm-badge]][npm-url]
[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. Implementation of in-memory [Node.js `fs` module API](https://nodejs.org/api/fs.html) and in-memory [browser File System API](https://developer.mozilla.org/en-US/docs/Web/API/File_System_API), as well as adapters from `fs` module to File Sytem API and from File Sytem API to `fs` module.
## Install
```shell
npm i memfs
```
## Resources
- [In-memory Node.js `fs` API](./docs/node/index.md)
- [In-memory browser File System (Access) API](./docs/fsa/fsa.md)
- [`fs` to File System (Access) API adapter](./docs/fsa/fs-to-fsa.md)
- [File System (Access) API to `fs` adapter](./docs/fsa/fsa-to-fs.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)
## 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