graalvm/elide.runtime.intrinsics.js.node.stream/ReadableIteratorOptions

ReadableIteratorOptions

@API

data class ReadableIteratorOptions(var destroyOnReturn: Boolean = true)

Readable Iterator Options

Defines the structure of options which relate to the Readable.iterator method.

Constructors

ReadableIteratorOptions

constructor(destroyOnReturn: Boolean = true)

Properties

destroyOnReturn

var destroyOnReturn: Boolean

When set to false, calling return on the async iterator, or exiting a for await...of iteration using a break, return, or throw will not destroy the stream.