Skip to content
Related Articles

Related Articles

Node.js Stream readable.isPaused() Method

Improve Article
Save Article
  • Last Updated : 12 Oct, 2021
Improve Article
Save Article

The readable.isPaused() method is an inbuilt application programming interface of Stream module which is used to check the current operating state of the Readable streams.

Syntax:

readable.isPaused()

Parameters: This method does not accept any parameters.

Return Value: It returns true if the Readable state is paused otherwise returns false.

Below examples illustrate the use of readable.isPaused() method in Node.js:

Example 1:




// Node.js program to demonstrate the     
// readable.isPaused() method  
  
// Include stream module
const stream = require('stream');
  
// Constructing readable stream
const readable = new stream.Readable();
  
// Calling isPaused method
readable.isPaused();


Output:

false

Example 2:




// Node.js program to demonstrate the     
// readable.isPaused() method  
  
// Include stream module
const stream = require('stream');
  
// Constructing readable stream
const readable = new stream.Readable();
  
// Calling isPaused method
readable.isPaused();
  
// Calling the pause() function
// to pause readable state
readable.pause();
  
// Again calling isPaused to check
// if its paued or not
readable.isPaused();


Output:

true

Reference: https://nodejs.org/api/stream.html#stream_readable_ispaused

My Personal Notes arrow_drop_up
Related Articles

Start Your Coding Journey Now!