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

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;
}>;

但在 @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>;

这段代码第一次出现在这次 merge commit 中 -> DefinitelyTyped/c886d9b，SimonSchick 搞错了这个 api 的返回值，相关 PR -> DefinitelyTyped#52775。

这个问题将在 PR -> DefinitelyTyped#55033 中修复，正在等待 merge。