Node.js 标准库 api 类型声明有误

高厉害

于 2021-08-10 13:33:06 发布

阅读量255

点赞数

CC 4.0 BY-SA版权

分类专栏：问题或技巧随便写点文章标签： DefinitelyTyped typescript node.js

本文链接：https://blog.csdn.net/qq_16181837/article/details/119567869

问题或技巧同时被 2 个专栏收录

12 篇文章

订阅专栏

随便写点

3 篇文章

订阅专栏

这篇博客指出Node.js v15.9.0中fs.promises.watch方法的类型声明错误，并强调了返回值应为异步迭代器对象。作者揭示了DefinitelyTyped库中的问题及其修复进展。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Node.js 标准库 api 类型声明有误

在 Node.js v15.9.0 加入的 api fsPromises.watch(filename[, options])，在 @types/node/fs/promises 中的返回值类型有误。

参考文档 -> https://nodejs.org/docs/v15.9.0/api/fs.html#fs_fspromises_watch_filename_options

在该 api 最初被加入时，返回值类型就已经在文档中明确给出为一个对象的异步迭代器:

type returnType = AsyncIterable<{
  eventType: string;
  filename: string | Buffer;
}>;

desc

但在 @types/node/fs/promises 中为：

function watch(
        filename: PathLike,
        options:
            | (WatchOptions & {
                  encoding: 'buffer';
              })
            | 'buffer'
    ): AsyncIterable<Buffer>;
function watch(filename: PathLike, options?: WatchOptions | BufferEncoding): AsyncIterable<string>;
function watch(filename: PathLike, options: WatchOptions | string): AsyncIterable<string> | AsyncIterable<Buffer>;