Reading and writing buffer data in Node.js - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a Buffer in Node.js?

A Buffer is a special object in Node.js used to store raw binary data. It allows you to work with streams of bytes directly, like reading files or network data.

beginner

How do you create a Buffer from a string in Node.js?

Use Buffer.from('your string') to create a Buffer containing the bytes of the string.

intermediate

Which method reads an unsigned 8-bit integer from a Buffer at a specific offset?

The method buffer.readUInt8(offset) reads an unsigned 8-bit integer from the Buffer at the given offset.

intermediate

How do you write a 16-bit unsigned integer to a Buffer at a specific offset?

Use buffer.writeUInt16LE(value, offset) to write a 16-bit unsigned integer in little-endian format at the offset.

advanced

Why is it important to specify endianness when reading or writing multi-byte values in a Buffer?

Endianness determines byte order. Specifying it ensures data is interpreted correctly across different systems, preventing errors in reading or writing multi-byte numbers.

Which method creates a Buffer from a string in Node.js?

A new Buffer('text')

B Buffer.from('text')

C Buffer.create('text')

D Buffer.string('text')

Buffer.from('text') is the modern and safe way to create a Buffer from a string.

What does buffer.readUInt8(0) return?

A An unsigned 8-bit integer from the start of the buffer

B A signed 8-bit integer from the start of the buffer

C A string from the buffer

D The length of the buffer

readUInt8 reads an unsigned 8-bit integer at the specified offset.

Which method writes a 32-bit unsigned integer in little-endian format to a Buffer?

A buffer.writeUInt32LE(value, offset)

B buffer.writeUInt32BE(value, offset)

C buffer.writeInt32LE(value, offset)

D buffer.writeInt32BE(value, offset)

writeUInt32LE writes a 32-bit unsigned integer in little-endian byte order.

What is the default encoding when converting a Buffer to a string using buffer.toString()?

A hex

B ascii

C base64

D utf8

utf8 is the default encoding for buffer.toString() in Node.js.

Why should you be careful with the offset when reading or writing Buffer data?

A Offset controls the Buffer size

B Because offset changes the encoding

C To avoid reading or writing outside the Buffer bounds causing errors

D Offset is only used for strings

Using an invalid offset can cause runtime errors or corrupt data.

Explain how to read and write numeric data using Node.js Buffers. Include how to handle byte order.

Think about how bytes are stored and accessed in memory.

Describe how to convert a string to a Buffer and back to a string in Node.js.

Consider how text is stored as bytes.

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