Error events and handling in Node.js

Introduction

Error events and handling help your program catch problems and respond without crashing. It keeps your app running smoothly and lets you fix or report errors.

When reading a file that might not exist

When making a network request that could fail

When working with streams that might emit errors

When handling user input that could be invalid

When connecting to a database that might be unreachable

Syntax

Node.js

emitter.on('error', (err) => {
  // handle the error here
});

Use the 'error' event on objects that emit events, like streams or servers.

Always handle 'error' events to avoid your program crashing.

Examples

This listens for errors when reading a file and logs a message if an error happens.

Node.js

const fs = require('fs');
const stream = fs.createReadStream('file.txt');

stream.on('error', (err) => {
  console.error('Error reading file:', err.message);
});

This handles errors on a network server, like if the port is already in use.

Node.js

const net = require('net');
const server = net.createServer();

server.on('error', (err) => {
  console.error('Server error:', err.message);
});

Sample Program

This program tries to read a file that does not exist. Instead of crashing, it catches the error and prints a message.

Node.js

import { createReadStream } from 'node:fs';

const stream = createReadStream('missing.txt');

stream.on('error', (err) => {
  console.log(`Caught error: ${err.message}`);
});

Important Notes

Always add an 'error' event listener on streams and servers to prevent crashes.

Errors provide useful info in the error object, like message and code.

Use try-catch blocks for synchronous code, but use 'error' events for asynchronous event emitters.

Summary

Error events let you catch problems in asynchronous code.

Always handle 'error' events on event emitters like streams and servers.

Handling errors keeps your app stable and user-friendly.

Practice

1. What is the main purpose of handling error events in Node.js event emitters?

easy

A. To improve the speed of the application

B. To automatically restart the server

C. To catch and respond to problems in asynchronous code

D. To log user activity

Solution

1. Step 1: Understand the role of error events

   Error events in Node.js are emitted when something goes wrong in asynchronous operations.

2. Step 2: Identify the purpose of handling errors

   Handling these events allows the program to respond properly, avoiding crashes and improving stability.

3. Final Answer:

   To catch and respond to problems in asynchronous code -> Option C

4. Quick Check:

   Error events catch async problems = B [OK]

Hint: Error events catch async problems to keep app stable [OK]

Common Mistakes:

• Thinking error events improve speed
• Assuming error events restart servers automatically
• Confusing error events with logging user actions

2. Which of the following is the correct way to listen for an error event on a Node.js stream named myStream?

easy

A. myStream.catch('error', (err) => { console.error(err); });

B. myStream.error((err) => { console.error(err); });

C. myStream.listen('error', (err) => { console.error(err); });

D. myStream.on('error', (err) => { console.error(err); });

Solution

1. Step 1: Recall the event listener syntax in Node.js

   Node.js uses the on method to listen to events on event emitters like streams.

2. Step 2: Verify the correct method and parameters

   The correct syntax is myStream.on('error', callback) where callback receives the error object.

3. Final Answer:

   myStream.on('error', (err) => { console.error(err); }); -> Option D

4. Quick Check:

   Use .on('error', callback) to handle errors [OK]

Hint: Use .on('error', callback) to handle errors [OK]

Common Mistakes:

• Using .error() instead of .on()
• Using .listen() or .catch() which don't exist
• Missing the event name string 'error'

3. Consider this code snippet:

const EventEmitter = require('events');
const emitter = new EventEmitter();
emitter.on('error', (err) => { console.log('Error caught:', err.message); });
emitter.emit('error', new Error('Oops!'));

What will be printed to the console?

medium

A. Error caught: Oops!

B. Unhandled 'error' event

C. Error: Oops!

D. No output

Solution

1. Step 1: Analyze the event listener setup

   The code sets a listener for the 'error' event that logs the error message prefixed by 'Error caught:'.

2. Step 2: Understand the emitted event

   The emitter emits an 'error' event with an Error object having message 'Oops!'. The listener runs and logs the message.

3. Final Answer:

   Error caught: Oops! -> Option A

4. Quick Check:

   Handled error event logs message = A [OK]

Hint: If error event has listener, it logs message [OK]

Common Mistakes:

• Expecting unhandled error crash
• Confusing error object with string output
• Thinking no output occurs without console.log

4. What is wrong with this code snippet?

const fs = require('fs');
const stream = fs.createReadStream('file.txt');
stream.emit('error', new Error('File not found'));

medium

A. Manually emitting 'error' event is incorrect; errors should come from the system

B. The error event listener is missing, so it will crash

C. The file path should be absolute

D. createReadStream does not emit error events

Solution

1. Step 1: Understand error event emission

   Error events on streams are emitted by the system when errors occur, not manually by user code.

2. Step 2: Identify the misuse of emit

   Calling emit('error') manually on a stream is not standard practice and can cause unexpected behavior.

3. Final Answer:

   Manually emitting 'error' event is incorrect; errors should come from the system -> Option A

4. Quick Check:

   Don't manually emit 'error' on streams [OK]

Hint: Let system emit errors; don't call emit('error') yourself [OK]

Common Mistakes:

• Thinking manual emit is normal
• Assuming missing listener causes error here
• Believing file path must be absolute always

5. You want to create a simple HTTP server in Node.js that handles errors gracefully. Which code snippet correctly handles errors on the server to avoid crashes?

hard

A. const http = require('http');
const server = http.createServer((req, res) => { res.end('Hello'); });
server.emit('error', new Error('Oops'));
server.listen(3000);

B. const http = require('http');
const server = http.createServer((req, res) => { res.end('Hello'); });
server.on('error', (err) => { console.error('Server error:', err); });
server.listen(3000);

C. const http = require('http');
const server = http.createServer((req, res) => { throw new Error('Oops'); });
server.listen(3000);

D. const http = require('http');
const server = http.createServer((req, res) => { res.end('Hello'); });
server.on('request', (req, res) => { throw new Error('Oops'); });
server.listen(3000);

Solution

1. Step 1: Identify proper error handling on server

   Listening to the 'error' event on the server allows catching errors and logging them without crashing.

2. Step 2: Check other options for issues

   const http = require('http'); const server = http.createServer((req, res) => { throw new Error('Oops'); }); server.listen(3000); throws error inside request handler without catching, causing crash. const http = require('http'); const server = http.createServer((req, res) => { res.end('Hello'); }); server.emit('error', new Error('Oops')); server.listen(3000); manually emits error, which is wrong. const http = require('http'); const server = http.createServer((req, res) => { res.end('Hello'); }); server.on('request', (req, res) => { throw new Error('Oops'); }); server.listen(3000); throws error inside 'request' event without handling.

3. Final Answer:

   Code that listens to 'error' event and logs errors -> Option B

4. Quick Check:

   Listen to 'error' event on server to handle errors [OK]

Hint: Always listen to 'error' event on servers to avoid crashes [OK]

Common Mistakes:

• Throwing errors without try/catch or error event listener
• Manually emitting error events on server
• Ignoring error events causing app crash