AsyncIterable : Object

An async iterable object is any object that has a Symbol.asyncIterator property whose value is a function that returns an AsyncIterator.

You can loop over all values in an async iterable object by using a for await (const value of asyncIterable) { } loop.

You may create your own async iterable object by assigning the Symbol.asyncIterator property to an async generator function (async function* () {}) or an object with a next() method.

See AsyncIterator for more details.

Spec

Instance Indexers

this[Symbol.asyncIterator] : Function<AsyncIterator>

Returns a function that produces an AsyncIterator for this object.

Example:

class UriFetcher {
  constructor(uris) {
    this._uris = uris;
  }

  async *[Symbol.asyncIterator]() {
    for (const uri of this._uris) {
      const response = await fetch(uri);
      yield await response.text();      
    }
  }
}

const fetcher = new UriFetcher(['/', '/Array']);

for await (const page of fetcher) {
  console.log(page.substring(0, 100));
}

Run

Results:

home license contribute feedback toggle light/dark mode