Trusted answers to developer questions
Trusted Answers to Developer Questions

Related Tags

node.js

How to use the buf.writeIntLE() function in Node.js

Ayesha Naeem

The buf.writeIntLE() function writes a given value at a given offset in the buffer that calls the buf.writeIntLE() function.

Prototype

Parameters and return value

The buf.writeIntLE() function accepts the following three parameters:

  • value: The value that is written to the buffer. Its maximum size is 48 bits or 6 bytes.
  • offset: The position in the buffer where the value is written. An offset of 3 would mean the value is written at the fourth-byte position. offset must fulfill the condition 0 <= offset <= buf.length - byteLength.
  • byteLength: The number of bytes that are written to the buffer. byteLength must be greater than zero and less than or equal to 6.

The buf.writeIntLE() function returns the number of bytes written plus the offset as an integer value.

The value is written to the buffer in the little-endian format.

In the little-endian format, the least significant byte is stored first and the most significant byte is stored last. For example, a hexadecimal value A1B2C3 will be stored as C3B2A1 in the little-endian format.

Example

The following example demonstrates how to write a little-endian value to a buffer.


//create a buffer
var buffer = Buffer.alloc(10)
console.log(buffer)
//define value
value = 0x192837465111
//write to buffer
buffer.writeIntLE(value, 2, 6)

console.log(buffer)

The program creates a buffer of zeros of size 10 bytes. It then defines the value and writes it to the buffer, starting from the third byte. The values in the buffer are in the little-endian format as illustrated.

The program will display an undefined behavior if the value is not a signed integer.

RELATED TAGS

node.js

CONTRIBUTOR

Ayesha Naeem
Copyright ©2022 Educative, Inc. All rights reserved
RELATED COURSES

View all Courses

Keep Exploring