memfs

Variables

• fs
• vol
• Volume

Functions

• createFsFromVolume()
• memfs()

Interfaces

• DirectoryJSON
• IFs

  • constants
  • Dirent
  • FSWatcher
  • promises
  • ReadStream
  • Stats
  • StatWatcher
  • WriteStream
• NestedDirectoryJSON

Type Aliases

• IFsWithVolume

variable fs

const fs: IFs;

variable vol

const vol: _Volume;

variable Volume

const Volume: typeof _Volume;

function createFsFromVolume

createFsFromVolume: (vol: _Volume) => IFs;

function memfs

memfs: (json?: NestedDirectoryJSON, cwd?: string) => { fs: IFs; vol: _Volume };

• Creates a new file system instance.

  Parameter json

  File system structure expressed as a JSON object. Use null for empty directories and empty string for empty files.

  Parameter cwd

  Current working directory. The JSON structure will be created relative to this path.

  Returns

  A memfs file system instance, which is a drop-in replacement for the fs module.

type IFsWithVolume

type IFsWithVolume = IFs & {
    __vol: _Volume;
};