Node.js Buffer.byteOffset Property

Last Updated : 23 Jan, 2023

The Buffer.byteOffset property is an inbuilt application programming interface of class Buffer within buffer module which is used to get the byte offset value of this buffer.

Syntax:

const Buffer.byteOffset

Return Value: This property return the object of array buffer.

Example 1: Filename: index.js

JavaScript
// Node.js program to demonstrate the
// Buffer.byteOffset property

// Creating and initializing arraybuffer object
const arrbuff = new ArrayBuffer(16);

// Getting buffer object from existing 
// arraybuffer object
const buffer = Buffer.from(arrbuff);

// Getting byteoffset of buffer
// by using byteoffset property
const bytoff = buffer.byteOffset;

// Display the result
console.log("byteoffset is : " + bytoff);

Output:

byteoffset is : 0

Example 2: Filename: index.js

JavaScript
// Node.js program to demonstrate the
// Buffer.byteOffset property

// Creating and initializing arraybuffer object
const arrbuff = new ArrayBuffer(16);

// Getting buffer object from existing 
// arraybuffer object
const buffer = Buffer.from(arrbuff);

// Getting byteoffset of buffer
// by using byteoffset property
const bytoff = buffer.byteOffset;

const buff = new Int8Array(buffer, bytoff, buffer.length);

// Display the result
console.log("Int8Arry object : " + buff);

Output:

Int8Arry object : 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0

Run the index.js file using the following command:

node index.js

Reference: https://nodejs.org/dist/latest-v12.x/docs/api/buffer.html#buffer_buf_byteoffset

Comment

Explore