AsyncGenerator

A JavaScript async generator object.

Async generators are built-in async iterable iterators with additional return() and throw() capabilities.

asAsyncIterable

RES

let asAsyncIterable: t<'yield, 'return, 'next> => AsyncIterable.t<'yield>

asAsyncIterable(generator) views generator as an AsyncIterable.t.

RES

let asAsyncIterableIterator: t<
  'yield,
  'return,
  'next,
> => AsyncIterableIterator.t<'yield, 'return, 'next>

asAsyncIterableIterator(generator) views generator as an AsyncIterableIterator.t.

RES

let asAsyncIterator: t<
  'yield,
  'return,
  'next,
> => AsyncIterator.t<'yield, 'return, 'next>

asAsyncIterator(generator) views generator as an AsyncIterator.t.

RES

let next: t<
  'yield,
  'return,
  'next,
> => promise<AsyncIterator.result<'yield, 'return>>

next(generator) advances generator without sending a value back in.

RES

let nextValue: (
  t<'yield, 'return, 'next>,
  'next,
) => promise<AsyncIterator.result<'yield, 'return>>

nextValue(generator, value) advances generator, sending value back into it.

RES

let returnValue: (
  t<'yield, 'return, 'next>,
  'return,
) => promise<AsyncIterator.result<'yield, 'return>>

returnValue(generator, value) completes generator with the final return value.

RES

type t<'yield, 'return, 'next> = AsyncIterable.t<'yield>

Type representing an async generator object.

RES

let throwError: (
  t<'yield, 'return, 'next>,
  exn,
) => promise<AsyncIterator.result<'yield, 'return>>

throwError(generator, error) throws error into generator.