Skip to main content
Up or down tonavigateEnter toselectEscape toclose⌘⇧KAI

method default.Readable.prototype.iterator

#Readable.prototype.iterator(options?: { destroyOnReturn?: boolean; }): AsyncIterator<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 #

#options: { destroyOnReturn?: boolean; }
optional

Return Type #

AsyncIterator<any>