Generator

A JavaScript generator object.

Generators are built-in iterable iterators with additional return() and throw() capabilities.

See Generator on MDN.

asIterable

RES

let asIterable: t<'yield, 'return, 'next> => Iterable.t<'yield>

asIterable(generator) views generator as an Iterable.t.

RES

let asIterator: t<
  'yield,
  'return,
  'next,
> => Iterator.t<'yield, 'return, 'next>

asIterator(generator) views generator as an Iterator.t.

RES

let asIteratorObject: t<
  'yield,
  'return,
  'next,
> => IteratorObject.t<'yield, 'return, 'next>

asIteratorObject(generator) views generator as an IteratorObject.t.

RES

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

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

RES

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

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

RES

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

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

RES

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

Type representing a generator object.

RES

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

throwError(generator, error) throws error into generator.