jsDocs.io logo

memfs

  • Version 3.4.7
  • Published
  • 179 kB
  • 1 dependency
  • Unlicense 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

Variables

variable fs

const fs: IFs;

    variable vol

    const vol: _Volume;

      variable Volume

      const Volume: typeof _Volume;

        Functions

        function createFsFromVolume

        createFsFromVolume: (vol: _Volume) => IFs;

          Interfaces

          interface DirectoryJSON

          interface DirectoryJSON {}

            index signature

            [key: string]: DirectoryContent;

              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: IPromisesAPI;

                        property ReadStream

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

                          property Stats

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

                            property StatWatcher

                            StatWatcher: new () => StatWatcher;

                              property WriteStream

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

                                Package Files (2)

                                Dependencies (1)

                                Dev Dependencies (16)

                                Peer Dependencies (0)

                                No peer dependencies.

                                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>