Open In App

Node.js Stream readable.readableObjectMode Property

Improve
Improve
Like Article
Like
Save
Share
Report

The readable.readableObjectMode property in a Readable Stream that is used to check the objectMode of the stream.

Syntax:

readable.readableObjectMode

Return Value: It returns the Boolean value.

Below examples illustrate the use of readable.readableObjectMode property in Node.js:

Example 1:




// Node.js program to demonstrate the     
// readable.readableObjectMode Property
   
// Accessing readable stream module
const Readable = require('readable-stream').Readable;
  
// Constructing readable stream and
// setting the objectMode value
const readable = Readable({objectMode: true});
  
// Defining ._read method
readable._read = () => {};
  
// Instructions for reading data
readable.on('readable', () => {
  let chunk;
  
  // Using while loop and calling
  // read method with parameter
  while (null !== (chunk = readable.read(4))) {
  
    // Displaying the chunk
    console.log(`read: ${chunk}`);
  }
});
  
// Calling readableObjectMode
// Property
readable.readableObjectMode;
console.log("objectMode is true!!");


Output:

objectMode is true!!

Example 2:




// Node.js program to demonstrate the     
// readable.readableObjectMode Property
   
// Accessing readable stream module
const Readable = require('readable-stream').Readable;
  
// Constructing readable stream and
// setting the objectMode value
const readable = Readable({objectMode: false});
  
// Defining ._read method
readable._read = () => {};
  
// Instructions for reading data
readable.on('readable', () => {
  let chunk;
  
  // Using while loop and calling
  // read method with parameter
  while (null !== (chunk = readable.read(4))) {
  
    // Displaying the chunk
    console.log(`read: ${chunk}`);
  }
});
  
// Calling readableObjectMode
// Property
readable.readableObjectMode;
console.log("objectMode is false!!");


Output:

objectMode is false!!

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



Last Updated : 12 Oct, 2021
Like Article
Save Article
Previous
Next
Share your thoughts in the comments
Similar Reads