The HH\AsyncIterator<Tv> interface

This page is a quick reference for people already familiar with the class. If this is new to you, we strongly recommend reading the introductory guides first:

Allows for the iteration over the values provided by an async function.

If an async function returns an AsyncIterator<T>, then you can iterate over the T values returned from that function.

async function countdown(int $start): AsyncIterator<int> { ... }

async function use_countdown(): Awaitable<void> {
  $async_iter = countdown(100);
  foreach ($async_gen await as $value) { ... }

Interface synopsis

interface AsyncIterator {...}