AsyncIterator

The type representing an async iterator.

next(asyncIterator)

Returns the next value of the iterator, if any.

See async iterator protocols on MDN.

Examples

• A simple example, getting the next value:

RESCRIPT
let {done, value} = await someAsyncIterator->AsyncIterator.next

• Complete example, including looping over all values:

RESCRIPT
// Let's pretend we get an async iterator returning ints from somewhere.
@val external asyncIterator: AsyncIterator.t<int> = "someAsyncIterator"


let processMyAsyncIterator = async () => {
  // ReScript doesn't have `for ... of` loops, but it's easy to mimic using a while loop.
  let break = ref(false)

  while !break.contents {
    // Await the next iterator value
    let {value, done} = await asyncIterator->AsyncIterator.next

    // Exit the while loop if the iterator says it's done
    break := done

    // This will log the (int) value of the current async iteration, if a value was returned.
    Console.log(value)
  }
}