Logo for jsDocs.io

memfs

  • Version 4.56.10
  • Published
  • 28.3 kB
  • 14 dependencies
  • Apache-2.0 license

Install

npm i memfs
yarn add memfs
pnpm add memfs

Overview

In-memory file-system with Node's fs API.

Index

Variables

Functions

Interfaces

Type Aliases

Variables

variable fs

const fs: IFs;

    variable vol

    const vol: Volume;

      Functions

      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.

        Interfaces

        interface IFs

        interface IFs extends Volume {}

          property constants

          constants: typeof constants;

            property Dirent

            Dirent: new (...args: any[]) => Dirent;

              property FSWatcher

              FSWatcher: new () => FSWatcher;

                property promises

                promises: FsPromisesApi;

                  property ReadStream

                  ReadStream: new (...args: any[]) => misc.IReadStream;

                    property Stats

                    Stats: new (...args: any[]) => Stats;

                      property StatWatcher

                      StatWatcher: new () => StatWatcher;

                        property WriteStream

                        WriteStream: new (...args: any[]) => IWriteStream;

                          Type Aliases

                          type IFsWithVolume

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

                            Package Files (1)

                            Dependencies (14)

                            Dev Dependencies (27)

                            Peer Dependencies (1)

                            Badge

                            To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                            You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/memfs.

                            • Markdown
                              [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/memfs)
                            • HTML
                              <a href="https://www.jsdocs.io/package/memfs"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>