Function createMockFs

createMockFs(
    mockFiles: _RequireExactlyOne,
    writeFileMockCallback?: (
        filePath: string,
        contents: string | Buffer<ArrayBufferLike>,
    ) => MaybePromise<void>,
): {
    existsSync: (filePath: string) => boolean;
    promises: {
        mkdir: (
            filePath: string,
            options?: { recursive: boolean },
        ) => Promise<string | void>;
        readFile: (filePath: string) => Promise<string | Buffer<ArrayBufferLike>>;
        writeFile: (
            filePath: string,
            contents: string | Buffer<ArrayBufferLike>,
        ) => Promise<void>;
    };
}
Mocks the built-in Node.js fs.promises.readFile method. See FileMocks for details on mocking strategies.
Parameters
- mockFiles: _RequireExactlyOne
- OptionalwriteFileMockCallback: (
  filePath: string,
  contents: string | Buffer<ArrayBufferLike>,
  ) => MaybePromise<void>
Returns {
    existsSync: (filePath: string) => boolean;
    promises: {
        mkdir: (
            filePath: string,
            options?: { recursive: boolean },
        ) => Promise<string | void>;
        readFile: (filePath: string) => Promise<string | Buffer<ArrayBufferLike>>;
        writeFile: (
            filePath: string,
            contents: string | Buffer<ArrayBufferLike>,
        ) => Promise<void>;
    };
}
- existsSync: (filePath: string) => boolean
  existsSync from 'node:fs'
- promises: {
      mkdir: (
          filePath: string,
          options?: { recursive: boolean },
      ) => Promise<string | void>;
      readFile: (filePath: string) => Promise<string | Buffer<ArrayBufferLike>>;
      writeFile: (
          filePath: string,
          contents: string | Buffer<ArrayBufferLike>,
      ) => Promise<void>;
  }
  'node:fs/promises'
  - mkdir: (filePath: string, options?: { recursive: boolean }) => Promise<string | void>
    mkdir from 'node:fs/promises'
  - readFile: (filePath: string) => Promise<string | Buffer<ArrayBufferLike>>
    readFile from 'node:fs/promises'
  - writeFile: (filePath: string, contents: string | Buffer<ArrayBufferLike>) => Promise<void>
    writeFile from 'node:fs/promises'
- Defined in src/public-mocks/mock-fs.ts:28

Function createMockFs

Parameters

existsSync: (filePath: string) => boolean

promises: { mkdir: ( filePath: string, options?: { recursive: boolean }, ) => Promise<string | void>; readFile: (filePath: string) => Promise<string | Buffer<ArrayBufferLike>>; writeFile: ( filePath: string, contents: string | Buffer<ArrayBufferLike>, ) => Promise<void>;}

mkdir: (filePath: string, options?: { recursive: boolean }) => Promise<string | void>

readFile: (filePath: string) => Promise<string | Buffer<ArrayBufferLike>>

writeFile: (filePath: string, contents: string | Buffer<ArrayBufferLike>) => Promise<void>

Settings

promises: {
mkdir: (
filePath: string,
options?: { recursive: boolean },
) => Promise<string | void>;
readFile: (filePath: string) => Promise<string | Buffer<ArrayBufferLike>>;
writeFile: (
filePath: string,
contents: string | Buffer<ArrayBufferLike>,
) => Promise<void>;
}