Reading and writing buffer data in Node.js

Introduction

Buffers let you handle raw binary data in Node.js. They help you read and write data like files or network streams easily.

Reading data from a file or network where data is in binary form.

Writing binary data to a file or sending it over a network.

Manipulating raw data like images or audio before processing.

Converting strings to bytes and back for encoding or decoding.

Syntax

Node.js

const buffer = Buffer.from(stringOrArray);
const byte = buffer[index];
buffer[index] = newByte;
const str = buffer.toString(encoding);

Buffers are like arrays but hold raw bytes (numbers from 0 to 255).

You can create buffers from strings, arrays, or allocate empty buffers.

Examples

Creates a buffer from the string 'hello'.

Node.js

const buf = Buffer.from('hello');
console.log(buf);

Creates an empty buffer of length 5, sets first byte to 'H', then prints the string.

Node.js

const buf = Buffer.alloc(5);
buf[0] = 72; // ASCII for 'H'
console.log(buf.toString());

Creates a buffer from an array of bytes representing 'Hello'.

Node.js

const buf = Buffer.from([72, 101, 108, 108, 111]);
console.log(buf.toString());

Sample Program

This program shows how to create a buffer from a string, read a byte, modify it, and convert back to a string.

Node.js

import { Buffer } from 'node:buffer';

// Create a buffer from a string
const buf = Buffer.from('Node.js');

// Read bytes from buffer
const firstByte = buf[0];

// Change a byte (e.g., change 'N' to 'n')
buf[0] = 110;

// Convert buffer back to string
const newString = buf.toString();

console.log('Original first byte:', firstByte);
console.log('Modified buffer as string:', newString);

Important Notes

Buffer indexes start at 0, like arrays.

Changing a byte changes the data directly in the buffer.

Use buffer.toString() to read buffer content as text.

Summary

Buffers hold raw binary data in Node.js.

You can read and write bytes directly using indexes.

Buffers convert easily between strings and binary data.

Practice

1. What is the primary purpose of a Buffer in Node.js?

easy

A. To manage HTTP requests automatically

B. To store JavaScript objects in memory

C. To hold raw binary data for reading and writing

D. To format strings for display in the console

Solution

1. Step 1: Understand what Buffer stores

   A Buffer is designed to hold raw binary data, not objects or formatted strings.

2. Step 2: Identify Buffer's main use

   Buffers allow reading and writing bytes directly, useful for binary data handling.

3. Final Answer:

   To hold raw binary data for reading and writing -> Option C

4. Quick Check:

   Buffer = raw binary data [OK]

Hint: Buffers store raw bytes, not objects or formatted text [OK]

Common Mistakes:

• Thinking Buffer stores JavaScript objects
• Confusing Buffer with string formatting tools
• Assuming Buffer manages HTTP requests

2. Which of the following is the correct way to create a Buffer of size 5 bytes filled with zeros?

easy

A. Buffer.new(5)

B. Buffer.alloc(5)

C. new Buffer(5, 0)

D. Buffer.create(5)

Solution

1. Step 1: Recall Buffer creation methods

   In modern Node.js, Buffer.alloc(size) creates a zero-filled buffer.

2. Step 2: Check other options

   Buffer.new and Buffer.create do not exist; new Buffer() is deprecated and unsafe.

3. Final Answer:

   Buffer.alloc(5) -> Option B

4. Quick Check:

   Use Buffer.alloc for safe zero-filled buffers [OK]

Hint: Use Buffer.alloc(size) for zero-filled buffers [OK]

Common Mistakes:

• Using deprecated new Buffer() constructor
• Trying non-existent Buffer.new or Buffer.create methods
• Not initializing buffer contents

3. What will be the output of this code?

const buf = Buffer.from('abc');
console.log(buf[1]);

medium

A. 98

B. b

C. 1

D. undefined

Solution

1. Step 1: Understand Buffer.from and indexing

   Buffer.from('abc') creates a buffer with ASCII codes of 'a', 'b', 'c'. Index 1 is 'b'.

2. Step 2: Check what buf[1] returns

   Buffer indexes return the byte value (number), not the character. 'b' ASCII code is 98.

3. Final Answer:

   98 -> Option A

4. Quick Check:

   Buffer index returns byte code, not character [OK]

Hint: Buffer indexes return byte numbers, not characters [OK]

Common Mistakes:

• Expecting character instead of ASCII code
• Confusing index with string position
• Assuming buf[1] returns a string

4. Identify the error in this code snippet:

const buf = Buffer.alloc(3);
buf.write('hello');
console.log(buf.toString());

medium

A. Buffer size is too small for the string 'hello'

B. Buffer.alloc cannot be used with write method

C. toString() cannot be called on a Buffer

D. write method requires encoding argument

Solution

1. Step 1: Check buffer size vs string length

   Buffer.alloc(3) creates 3 bytes, but 'hello' needs 5 bytes to store fully.

2. Step 2: Understand write behavior

   write writes as many bytes as fit; here it truncates 'hello' to 'hel'.

3. Final Answer:

   Buffer size is too small for the string 'hello' -> Option A

4. Quick Check:

   Buffer too small truncates written string [OK]

Hint: Buffer must be large enough to hold full string [OK]

Common Mistakes:

• Thinking write needs encoding argument always
• Assuming toString() is invalid on Buffer
• Believing Buffer.alloc disallows write

5. You want to copy the first 4 bytes from one buffer src to another buffer dest starting at index 2 in dest. Which code correctly does this?

hard

A. dest.copy(src, 2, 0, 4);

B. dest.copy(src, 0, 2, 6);

C. src.copy(dest, 0, 2, 6);

D. src.copy(dest, 2, 0, 4);

Solution

1. Step 1: Understand Buffer.copy parameters

   The method is source.copy(target, targetStart, sourceStart, sourceEnd).

2. Step 2: Match parameters to requirement

   Copy from src starting at 0 to 4 bytes, into dest starting at index 2.

3. Final Answer:

   src.copy(dest, 2, 0, 4); -> Option D

4. Quick Check:

   source.copy(target, targetStart, sourceStart, sourceEnd) [OK]

Hint: source.copy(target, targetStart, sourceStart, sourceEnd) [OK]

Common Mistakes:

• Swapping source and target buffers
• Mixing up start and end indexes
• Using copy on wrong buffer object