Skip to content

Latest commit

 

History

History

memory

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

@file-services/memory

npm version package size

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