模拟特定函数重载签名

Mocking specific function overload signature(模拟特定函数重载签名)

问题描述

我有以下代码

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这是我要在测试中使用的签名？

推荐答案

根据@andreyunugros链接答案，以下内容有效；

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

这篇关于模拟特定函数重载签名的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持编程学习网！