Skip to main content

iterator

method ReadableBase.prototype.iterator
Jump to headingReadableBase.prototype.iterator(options?: { destroyOnReturn?: boolean; }): AsyncIterableIterator<any>

The iterator created by this method gives users the option to cancel the destruction of the stream if the for await...of loop is exited by return, break, or throw, or if the iterator should destroy the stream if the stream emitted an error during iteration.

Parameters Jump to heading

optional
Jump to headingoptions: { destroyOnReturn?: boolean; }

Return Type Jump to heading

AsyncIterableIterator<any>
Back to top