TypeScript：异步生成器

Question

我想要一个这样的功能：

export async function* iterateDir(dir: string) {
    let list = await fs.readdir(dir); // fs-promise implementation of readdir
    for (let file of list) {
        yield file;
    }
}

我会使用如下：

for (let file in iterateDir(dir)) {
    processFile(file);
}

这不起作用，因为函数不能既是异步又是生成器。

我将如何构建代码以实现相同的目标？

1. 如果我将 await fs.readdir 更改为回调，我假设外部 for..of 循环不会等待。
2. 如果我去掉生成器并且目录很大，iterateDir() 会很慢。

供参考：async generator function proposal

Answer 1

TypeScript 2.3 支持此功能 - tracked issue

它引入了一些新类型，特别是：

interface AsyncIterable<T> {
    [Symbol.asyncIterator](): AsyncIterator<T>;
}

但最重要的是它还引入了for await ... of

for await (const line of readLines(filePath)) {
  console.log(line);
}

在哪里

async function* readLines(path) {
   //await and yield ...
}

请注意，如果你想尝试这个，你需要配置 typescript 让它知道你有运行时支持（添加“esnext.asynciterable”到lib 列表）你可能需要填充Symbol.asyncIterator .见TS2318: Cannot find global type 'AsyncIterableIterator' - async generator

Answer 2

未来值流称为Observable。所以最自然的就是使用 RxJS 或 most.js 之类的库。如果您不想引入一个新的复杂库只使用一次，请使用带有回调的旧方法：

const path = require("path");
const fs = require("mz/fs");

async function listDirectory(dirName, cb, level = 0) {
  for (let fileName of await fs.readdir(dirName)) {
    let absName = path.resolve(dirName, fileName);
    let isDirectory = (await fs.stat(absName)).isDirectory();
    cb({ level, fileName });
    if (isDirectory) {
      await listDirectory(absName, cb, level + 1);
    }
  }
}

listDirectory(".", ({ level, fileName }) => {
  console.log(" ".repeat(level) + fileName);
});

如果您尝试将回调转换为更好的抽象，您迟早会重新发现 RxJS。这类似于将一次性回调转换为 Promise。