Type Alias VirtualFs

Type declaration

• createWriteStream: typeof nodeFs.createWriteStream

• globSync: MemFs["globSync"]

• mkdirSync: typeof nodeFs.mkdirSync

• mkdtempSync: typeof nodeFs.mkdtempSync

• promises: Omit<BaseVirtualFs["promises"], "writeFile" | "readFile"> & {
      glob: MemFs["promises"]["glob"];
      readFile: {
          (path: string): Promise<Buffer>;
          (path: string, options: BufferEncoding | {
              encoding: BufferEncoding;
          }): Promise<string>;
      };
      writeFile: ((file: string, data: string | Buffer, options?: BufferEncoding | {
          encoding?: BufferEncoding;
          mode?: string | number;
      }) => Promise<void>);
  }

• readFileSync: {
      (path: string, options: BufferEncoding | {
          encoding: BufferEncoding;
      }): string;
      (path: string): Buffer;
  }

  • • (path, options): string

    • Parameters

      • path: string
      • options: BufferEncoding | {
            encoding: BufferEncoding;
        }

      Returns string

    • (path): Buffer

    • Parameters

      • path: string

      Returns Buffer

• 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: string, data: string | Buffer, options?: BufferEncoding | {
      encoding?: BufferEncoding;
      mode?: string | number;
  }) => void)

  • • (file, data, options?): void

    • Parameters

      • file: string
      • data: string | Buffer
      • Optionaloptions: BufferEncoding | {
            encoding?: BufferEncoding;
            mode?: string | number;
        }

      Returns void