Class MemoryFileSystem

Memory file system that instead of writing to disk writes to memory and stores them in a JSON object.

Hierarchy (View Summary)

NodeFileSystem
- MemoryFileSystem

Index

Constructors

constructor

new MemoryFileSystem(
files?: { [fileName: string]: string | Buffer<ArrayBufferLike> },
): MemoryFileSystem
Parameters
- files: { [fileName: string]: string | Buffer<ArrayBufferLike> } = {}
Returns MemoryFileSystem
Overrides NodeFileSystem.constructor
- Defined in packages/core/src/fs/memoryFileSystem.ts:14

Properties

`Protected` `Readonly`innerFs

innerFs: __module = fs

Accessors

`Protected`memFs

get memFs(): Volume
Returns Volume
- Defined in packages/core/src/fs/memoryFileSystem.ts:10

Methods

appendFile

appendFile(
    path: string,
    body: string | Buffer<ArrayBufferLike>,
    options?: OutputOptions,
): Promise<void>
Append data to an existing file to the file system, when the directory does not exists it will be created.
Parameters
- path: string
  path to the file to read
- body: string | Buffer<ArrayBufferLike>
  body to write to the file
- Optionaloptions: OutputOptions
  write options
Returns Promise<void>
Inherited from NodeFileSystem.appendFile
- Defined in packages/core/src/fs/fileSystem.ts:227

createDirectory

createDirectory(path: string): Promise<void>
Create a new directory at the specified path. No error should be thrown when the directory already exists. Operations should be idempotent and recursive, so when creating a directory /a/b/c and /a or /a/b do not exists, these should be created as well.
Parameters
- path: string
  path to the directory to create
Returns Promise<void>
Inherited from NodeFileSystem.createDirectory
- Defined in packages/core/src/fs/nodeFileSystem.ts:49

find

find(patterns: GlobPatterns, options?: FindOptions): AsyncGenerator<string>
Find files and or folders matching the specified glob pattern as an async iterable. If the result is not iterated completely, the search is stopped. When you need the results as an array, use the Iterable.spreadAsync method to convert the async iterable into an array.

By default the current working directory is used as the base directory for the search.

You can specify multiple glob patterns to match by specifying an array of glob patterns.

When a limit is specified, the search is stopped after the specified number of results is reached.

When a depth is specified, the search does not go deeper than the specified depth.
Parameters
- patterns: GlobPatterns
  Glob patterns to match
- Optionaloptions: FindOptions
  find options
Returns AsyncGenerator<string>
Async iterable of matching files and or folders
Example
```
for await (const file of fs.find('*.ts')) {
    console.log(file);
}
```
Inherited from NodeFileSystem.find
- Defined in packages/core/src/fs/fileSystem.ts:187

findFiles

findFiles(globPatterns: string | string[]): Promise<string[]>
Find files matching the specified glob pattern(s)
Parameters
- globPatterns: string | string[]
  Glob patterns to match files with
Returns Promise<string[]>
Inherited from NodeFileSystem.findFiles
- Defined in packages/core/src/fs/fileSystem.ts:268

getBuffer

getBuffer(): Buffer
Get the file system as a buffer and return it.

Returns Buffer
Serialized file system
- Defined in packages/core/src/fs/memoryFileSystem.ts:22

`Protected`globFs

globFs(): {
    lstat: typeof lstat;
    lstatSync: any;
    readdir: typeof readdir;
    readdirSync: {
        (
            path: PathLike,
            options?:
                | null
                | BufferEncoding
                | {
                    encoding: BufferEncoding | null;
                    recursive?: boolean;
                    withFileTypes?: false;
                },
        ): string[];
        (
            path: PathLike,
            options:
                | "buffer"
                | { encoding: "buffer"; recursive?: boolean; withFileTypes?: false },
        ): Buffer<ArrayBufferLike>[];
        (
            path: PathLike,
            options?:
                | null
                | BufferEncoding
                | ObjectEncodingOptions & { recursive?: boolean; withFileTypes?: false },
        ): string[] | Buffer<ArrayBufferLike>[];
        (
            path: PathLike,
            options: ObjectEncodingOptions & {
                recursive?: boolean;
                withFileTypes: true;
            },
        ): Dirent<string>[];
        (
            path: PathLike,
            options: { encoding: "buffer"; recursive?: boolean; withFileTypes: true },
        ): Dirent<Buffer<ArrayBufferLike>>[];
    };
    stat: typeof stat;
    statSync: any;
}
Returns {
    lstat: typeof lstat;
    lstatSync: any;
    readdir: typeof readdir;
    readdirSync: {
        (
            path: PathLike,
            options?:
                | null
                | BufferEncoding
                | {
                    encoding: BufferEncoding | null;
                    recursive?: boolean;
                    withFileTypes?: false;
                },
        ): string[];
        (
            path: PathLike,
            options:
                | "buffer"
                | { encoding: "buffer"; recursive?: boolean; withFileTypes?: false },
        ): Buffer<ArrayBufferLike>[];
        (
            path: PathLike,
            options?:
                | null
                | BufferEncoding
                | ObjectEncodingOptions & { recursive?: boolean; withFileTypes?: false },
        ): string[] | Buffer<ArrayBufferLike>[];
        (
            path: PathLike,
            options: ObjectEncodingOptions & {
                recursive?: boolean;
                withFileTypes: true;
            },
        ): Dirent<string>[];
        (
            path: PathLike,
            options: { encoding: "buffer"; recursive?: boolean; withFileTypes: true },
        ): Dirent<Buffer<ArrayBufferLike>>[];
    };
    stat: typeof stat;
    statSync: any;
}
- lstat: typeof lstat
- lstatSync: any
- readdir: typeof readdir
- readdirSync: {
      (
          path: PathLike,
          options?:
              | null
              | BufferEncoding
              | {
                  encoding: BufferEncoding | null;
                  recursive?: boolean;
                  withFileTypes?: false;
              },
      ): string[];
      (
          path: PathLike,
          options:
              | "buffer"
              | { encoding: "buffer"; recursive?: boolean; withFileTypes?: false },
      ): Buffer<ArrayBufferLike>[];
      (
          path: PathLike,
          options?:
              | null
              | BufferEncoding
              | ObjectEncodingOptions & { recursive?: boolean; withFileTypes?: false },
      ): string[] | Buffer<ArrayBufferLike>[];
      (
          path: PathLike,
          options: ObjectEncodingOptions & {
              recursive?: boolean;
              withFileTypes: true;
          },
      ): Dirent<string>[];
      (
          path: PathLike,
          options: { encoding: "buffer"; recursive?: boolean; withFileTypes: true },
      ): Dirent<Buffer<ArrayBufferLike>>[];
  }
- stat: typeof stat
- statSync: any
Inherited from NodeFileSystem.globFs
- Defined in packages/core/src/fs/nodeFileSystem.ts:69

isDirectory

isDirectory(path: string): Promise<boolean>
Returns true if the path exists and is a folder, returns false when the path does not exists or is not a folder.
Parameters
- path: string
  Path to check
Returns Promise<boolean>
Inherited from NodeFileSystem.isDirectory
- Defined in packages/core/src/fs/fileSystem.ts:129

isFile

isFile(path: string): Promise<boolean>
Returns true if the path exists and is a file, returns false when the path does not exists or is not a file.
Parameters
- path: string
  Path to check
Returns Promise<boolean>
Inherited from NodeFileSystem.isFile
- Defined in packages/core/src/fs/fileSystem.ts:121

outputFile

outputFile(
    path: string,
    body?: string | Buffer<ArrayBufferLike>,
    options?: OutputOptions,
): Promise<void>
Write a file to the file system, when the directory does not exists it will be created.
Parameters
- path: string
  path to the file to read
- Optionalbody: string | Buffer<ArrayBufferLike>
  body to write to the file
- Optionaloptions: OutputOptions
  write options
Returns Promise<void>
Inherited from NodeFileSystem.outputFile
- Defined in packages/core/src/fs/fileSystem.ts:154

pathExists

pathExists(path: string): Promise<boolean>
Checks if the specified path exists on the file system
Parameters
- path: string
  Path to check
Returns Promise<boolean>
Inherited from NodeFileSystem.pathExists
- Defined in packages/core/src/fs/fileSystem.ts:137

readDirectory

readDirectory(path: string): Promise<FileInfo[]>
Read the contents of a directs; returns an array with the files and folders contained in the specified directory.
Parameters
- path: string
  Directory
Returns Promise<FileInfo[]>
Inherited from NodeFileSystem.readDirectory
- Defined in packages/core/src/fs/nodeFileSystem.ts:39

readFile

readFile(path: string): Promise<Buffer<ArrayBufferLike>>
Reads the specified file path into a NodeJS Buffer object
Parameters
- path: string
  path to the file to read
Returns Promise<Buffer<ArrayBufferLike>>
Inherited from NodeFileSystem.readFile
- Defined in packages/core/src/fs/nodeFileSystem.ts:29

readFileAsString

readFileAsString(path: string, encoding?: BufferEncoding): Promise<string>
Read a file and returns the file body as String
Parameters
- path: string
- encoding: BufferEncoding = 'utf-8'
Returns Promise<string>
Inherited from NodeFileSystem.readFileAsString
- Defined in packages/core/src/fs/fileSystem.ts:144

stat

stat(path: string, options?: StatsOptions): Promise<undefined | FileStat>
Get file statistics; returns undefined when the file does not exists
Parameters
- path: string
  Path to check
- Optionaloptions: StatsOptions
Returns Promise<undefined | FileStat>
Inherited from NodeFileSystem.stat
- Defined in packages/core/src/fs/nodeFileSystem.ts:15

writeFile

writeFile(
    path: string,
    data?: string | Buffer<ArrayBufferLike>,
    options?: WriteOptions,
): Promise<void>
Write a file to the file system, when the directory does not exists it will be created.
Parameters
- path: string
  path to the file to read
- Optionaldata: string | Buffer<ArrayBufferLike>
  data to write to the file
- Optionaloptions: WriteOptions
  write options
Returns Promise<void>
Inherited from NodeFileSystem.writeFile
- Defined in packages/core/src/fs/nodeFileSystem.ts:59

`Static`fromBuffer

fromBuffer(buffer: Buffer): MemoryFileSystem
Instantiate a new memory file system from a buffer object containing the file system.
Parameters
- buffer: Buffer
  Buffer to read the file system from previously written by getBuffer
Returns MemoryFileSystem
Memory file system
- Defined in packages/core/src/fs/memoryFileSystem.ts:31

Class MemoryFileSystem

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MemoryFileSystem

Properties

Protected ReadonlyinnerFs

Accessors

ProtectedmemFs

Returns Volume

Methods

appendFile

Parameters

Returns Promise<void>

createDirectory

Parameters

Returns Promise<void>

find

Parameters

Returns AsyncGenerator<string>

Example

findFiles

Parameters

Returns Promise<string[]>

getBuffer

Returns Buffer

ProtectedglobFs

lstat: typeof lstat

lstatSync: any

readdir: typeof readdir

stat: typeof stat

statSync: any

isDirectory

Parameters

Returns Promise<boolean>

isFile

Parameters

Returns Promise<boolean>

outputFile

Parameters

Returns Promise<void>

pathExists

Parameters

Returns Promise<boolean>

readDirectory

Parameters

Returns Promise<FileInfo[]>

readFile

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

readFileAsString

Parameters

Returns Promise<string>

stat

Parameters

Returns Promise<undefined | FileStat>

writeFile

Parameters

Returns Promise<void>

StaticfromBuffer

Parameters

Returns MemoryFileSystem

Settings

On This Page

`Protected` `Readonly`innerFs

`Protected`memFs

`Protected`globFs

`Static`fromBuffer