Skip to main content

isPaused

method ReadableBase.prototype.isPaused
Jump to headingReadableBase.prototype.isPaused(): boolean

The readable.isPaused() method returns the current operating state of the Readable. This is used primarily by the mechanism that underlies the readable.pipe() method. In most typical cases, there will be no reason to use this method directly.

const readable = new stream.Readable();

readable.isPaused(); // === false
readable.pause();
readable.isPaused(); // === true
readable.resume();
readable.isPaused(); // === false

Return Type Jump to heading

boolean
Back to top