模拟特定函数重载签名

Question

我有以下代码

import { readdir } from 'fs/promises';

const files: string[] = await readdir('/original/file/path');

我正在尝试测试

import * as fsPromisesModule from "fs/promises";

stub(fsPromisesModule, "readdir").callsFake(async (): Promise<string[]> => ['/test/file/path']);

但我收到以下错误

Type 'Promise<string[]>' is not assignable to type 'Promise<Dirent[]>'.
  Type 'string[]' is not assignable to type 'Dirent[]'.
    Type 'string' is not assignable to type 'Dirent'.ts(2322)

promises.d.ts 文件包含以下签名

    function readdir(
        path: PathLike,
        options?:
            | (ObjectEncodingOptions & {
                  withFileTypes?: false | undefined;
              })
            | BufferEncoding
            | null
    ): Promise<string[]>;

    function readdir(
        path: PathLike,
        options:
            | {
                  encoding: 'buffer';
                  withFileTypes?: false | undefined;
              }
            | 'buffer'
    ): Promise<Buffer[]>;

    function readdir(
        path: PathLike,
        options?:
            | (ObjectEncodingOptions & {
                  withFileTypes?: false | undefined;
              })
            | BufferEncoding
            | null
    ): Promise<string[] | Buffer[]>;

    function readdir(
        path: PathLike,
        options: ObjectEncodingOptions & {
            withFileTypes: true;
        }
    ): Promise<Dirent[]>;

存根中使用了最后一个签名，但我想使用第一个签名。我如何告诉 TypeScript 这是我想在测试中使用的签名？

Answer 1

根据@andreyunugros 链接的回答，以下方法有效；

(stub(fsPromisesModule, "readdir") as unknown as SinonStub<[p: PathLike], Promise<string[]>>).callsFake(async (): Promise<string[]> => (['/file/path/name']);

模拟特定函数重载签名

Mocking specific function overload signature

javascript

overloading

mocking

sinon

typescript