Node.js - Buffer.toJSON() Method

The NodeJS Buffer.toJSON() method returns a JSON object for the given buffer.

Syntax

Following is the syntax of the Node.JS Buffer.toJSON() Method −

buf.toJSON()

Parameters

This method does not have any parameters.

Return value

The method buffer.toJSON() returns a json object.

Example

To create a buffer, we are going to make use of NodeJS Buffer.from() method −

const buffer = Buffer.from('Hello');
console.log(buffer.toJSON());

The buffer is created with the string "Hello".

Output

{ type: 'Buffer', data: [ 72, 101, 108, 108, 111 ] }

Example

In this example the buffer is created with an array of numbers. The Buffer.toJSON() output is as shown below −

const buffer = Buffer.from([1,2,3,4,5,6,7,8,9,10]);
console.log(buffer.toJSON());

Output

{ type: 'Buffer', data: [
   1, 2, 3, 4,  5,
   6, 7, 8, 9, 10
] }

You can also make use of the JSON.stringify() method on the Buffer created.

const buffer = Buffer.from([1,2,3,4,5,6,7,8,9,10]);
console.log(JSON.stringify(buffer));

Output

{"type":"Buffer","data":[1,2,3,4,5,6,7,8,9,10]}

Example

In this example will make use of the Buffer.alloc() and fill it with a value.

const buffer = Buffer.alloc(10);
buffer.fill('H');
console.log(buffer.toJSON());

Output

{
   type: 'Buffer',
   data: [
      72, 72, 72, 72, 72,
      72, 72, 72, 72, 72
   ]
}