Type alias VirtualFs

VirtualFs: Omit<BaseVirtualFs, "writeFileSync" | "readFileSync" | "statSync" | "promises" | "mkdtempSync" | "createWriteStream" | "mkdirSync"> & {
    createWriteStream: typeof nodeFs.createWriteStream;
    mkdirSync: typeof nodeFs.mkdirSync;
    mkdtempSync: typeof nodeFs.mkdtempSync;
    promises: Omit<BaseVirtualFs["promises"], "writeFile" | "readFile"> & {
        readFile: {
            (path): Promise<Buffer>;
            (path, encoding): Promise<string>;
        };
        writeFile: ((file, data, options?) => Promise<void>);
    };
    readFileSync: {
        (path): Buffer;
        (path, encoding): string;
    };
    statSync: typeof nodeFs.statSync;
    writeFileSync: ((file, data, encoding?) => void);
}

Type declaration

  • createWriteStream: typeof nodeFs.createWriteStream
  • mkdirSync: typeof nodeFs.mkdirSync
  • mkdtempSync: typeof nodeFs.mkdtempSync
  • promises: Omit<BaseVirtualFs["promises"], "writeFile" | "readFile"> & {
        readFile: {
            (path): Promise<Buffer>;
            (path, encoding): Promise<string>;
        };
        writeFile: ((file, data, options?) => Promise<void>);
    }
  • readFileSync: {
        (path): Buffer;
        (path, encoding): string;
    }
      • (path): Buffer

      • Parameters

        • path: string

        Returns Buffer

      • (path, encoding): string

      • Parameters

        • path: string
        • encoding: BufferEncoding

        Returns string

  • statSync: typeof nodeFs.statSync

    there are some differences between node:fs and memfs for statSync around bigint stats. Be careful if using those

  • writeFileSync: ((file, data, encoding?) => void)
      • (file, data, encoding?): void

      • Parameters

        • file: string
        • data: string | Buffer
        • Optional encoding: BufferEncoding

        Returns void

Settings

Member Visibility

Theme