memfs

Variables

• fs
• vol

Functions

• createFsFromVolume()
• memfs()

Interfaces

• IFs

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

  • cwd
  • process

Type Aliases

• IFsWithVolume

variable fs

const fs: IFs;

variable vol

const vol: Volume;

function createFsFromVolume

createFsFromVolume: (vol: Volume) => IFs;

function memfs

memfs: (
    json?: NestedDirectoryJSON,
    cwdOrOpts?: string | MemfsOptions
) => { 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 cwdOrOpts

  Current working directory (string) or options object. The JSON structure will be created relative to the cwd path.

  Returns

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

type IFsWithVolume

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