@file-services/memory
v9.4.1
Published
An in-memory, sync/async, file system implementation.
Downloads
11,305
Readme
@file-services/memory
An in-memory, sync/async, file system implementation.
Contains a subset of node's fs
API with additional helper functions.
Features:
- Tiny.
- Isomorphic. Works in both Node.js and web-browsers.
- Implements the watch service API (for events).
- Case insensitive.
Getting started
Install library in project:
npm i @file-services/memory
Then, use the programmatic API:
import { createMemoryFs } from "@file-services/memory";
const fs = createMemoryFs();
// library uses `posix`-style paths
// and exposes a subset of `fs` API
fs.writeFileSync("/file-in-root", "file contents");
// several helper functions are included
fs.populateDirectorySync("/src", {
"index.ts": "/* source code */",
"another-file.ts": "/* more source code */",
});
fs.fileExistsSync("/src/another-file.ts"); // returns true
License
MIT