Once listeners in Node.js

Introduction

Once listeners let you run a function only one time when an event happens. This helps avoid running the same code many times by mistake.

You want to handle a user login event only the first time it happens.

You want to load some data once when a server starts.

You want to clean up resources only once after a task finishes.

You want to listen for a connection event just the first time a client connects.

Syntax

Node.js

const EventEmitter = require('events');
const emitter = new EventEmitter();
emitter.once('eventName', listenerFunction);

The listenerFunction runs only once for the first 'eventName' event.

After running once, the listener is automatically removed.

Examples

The message 'Hello once!' prints only once even though we emit 'greet' twice.

Node.js

const EventEmitter = require('events');
const emitter = new EventEmitter();

emitter.once('greet', () => {
  console.log('Hello once!');
});

emitter.emit('greet');
emitter.emit('greet');

The 'onConnect' function runs only the first time the 'connect' event happens.

Node.js

const EventEmitter = require('events');
const emitter = new EventEmitter();

function onConnect() {
  console.log('Client connected once');
}

emitter.once('connect', onConnect);

emitter.emit('connect');
emitter.emit('connect');

Sample Program

This program creates a Server class that emits a 'start' event. The listener runs only once even though the event is emitted twice.

Node.js

const EventEmitter = require('events');

class Server extends EventEmitter {
  start() {
    console.log('Server starting...');
    this.emit('start');
  }
}

const server = new Server();

// Listen once for the 'start' event
server.once('start', () => {
  console.log('Server has started - this runs only once');
});

// Emit 'start' event twice
server.start();
server.start();

Important Notes

Time complexity: Adding a once listener is O(1), running it is O(1).

Space complexity: Uses memory for one listener until it runs.

Common mistake: Expecting the listener to run multiple times when it only runs once.

Use once listeners when you want to react only to the first occurrence of an event, unlike regular listeners that run every time.

Summary

Once listeners run their function only the first time an event happens.

They automatically remove themselves after running once.

Use them to handle events that should trigger only a single time.

Practice

1. What is the main behavior of a once listener in Node.js event handling?

easy

A. It runs twice before removing itself automatically.

B. It runs only the first time the event is emitted and then removes itself.

C. It runs every time the event is emitted without removing itself.

D. It never runs automatically and must be triggered manually.

Solution

1. Step 1: Understand the purpose of once listeners

   Once listeners are designed to handle an event only once, meaning they execute their callback a single time.

2. Step 2: Recognize automatic removal behavior

   After running once, the listener removes itself automatically to prevent further executions.

3. Final Answer:

   It runs only the first time the event is emitted and then removes itself. -> Option B

4. Quick Check:

   Once listener = runs once then removes [OK]

Hint: Once listeners run once then auto-remove themselves [OK]

Common Mistakes:

• Thinking once listeners run multiple times
• Confusing once with on listeners
• Assuming manual removal is needed

2. Which of the following is the correct syntax to add a once listener to an EventEmitter instance emitter for event 'start'?

easy

A. emitter.once('start', () => { console.log('Started'); });

B. emitter.on('start', () => { console.log('Started'); });

C. emitter.once('start', console.log('Started'));

D. emitter.once('start', function console.log('Started'));

Solution

1. Step 1: Identify the correct method for once listeners

   The method to add a once listener is once, not on.

2. Step 2: Check the callback syntax

   The callback must be a function, so () => { console.log('Started'); } is correct. Passing the result of console.log directly is wrong.

3. Final Answer:

   emitter.once('start', () => { console.log('Started'); }); -> Option A

4. Quick Check:

   Use emitter.once(event, callback) with a function [OK]

Hint: Use emitter.once with a function callback [OK]

Common Mistakes:

• Using emitter.on instead of emitter.once
• Passing console.log() call instead of function
• Incorrect function syntax in listener

3. Consider this code snippet:

const EventEmitter = require('events');
const emitter = new EventEmitter();

emitter.once('ping', () => console.log('Ping received'));
emitter.emit('ping');
emitter.emit('ping');

What will be the output?

medium

A. No output

B. Ping received
Ping received

C. Ping received

D. Error thrown

Solution

1. Step 1: Understand emitter.once behavior

   The listener runs only once on the first emit('ping') call.

2. Step 2: Analyze the two emit calls

   The first emit('ping') triggers the listener and prints 'Ping received'. The second call finds no listener because it was removed after first run.

3. Final Answer:

   Ping received -> Option C

4. Quick Check:

   once listener runs once, so output once [OK]

Hint: once listeners run only on first emit call [OK]

Common Mistakes:

• Expecting output on second emit
• Confusing once with on listeners
• Assuming listener stays after first run

4. What is wrong with this code snippet?

const EventEmitter = require('events');
const emitter = new EventEmitter();

emitter.once('data', console.log('Data event'));
emitter.emit('data');

medium

A. The listener callback is called immediately, not on event emit.

B. The event name 'data' is invalid for once listeners.

C. The emitter.emit call is missing a callback function.

D. The once method does not exist on EventEmitter.

Solution

1. Step 1: Check how the callback is passed

   The code passes console.log('Data event') which calls console.log immediately and passes its return (undefined) as listener.

2. Step 2: Understand correct callback usage

   The callback should be a function, e.g., () => console.log('Data event'), to run only on event emit.

3. Final Answer:

   The listener callback is called immediately, not on event emit. -> Option A

4. Quick Check:

   Pass function, not function call, as listener [OK]

Hint: Pass function, not function call, as listener [OK]

Common Mistakes:

• Calling function instead of passing it
• Assuming event name invalid
• Thinking once method is missing

5. You want to log a message only the first time a user connects to your server using an EventEmitter server. Which code snippet correctly achieves this and prevents multiple logs if the user reconnects?

hard

A. server.on('connect', () => console.log('User connected'));

B. server.on('connect', console.log('User connected'));

C. server.once('connect', console.log('User connected'));

D. server.once('connect', () => console.log('User connected'));

Solution

1. Step 1: Identify the requirement for single execution

   Logging only once means the listener should run once and then remove itself.

2. Step 2: Choose the correct method and callback syntax

   server.once('connect', () => console.log('User connected')) uses the once method with a function callback, ensuring single log on first connect.

3. Final Answer:

   server.once('connect', () => console.log('User connected')); -> Option D

4. Quick Check:

   Use once with function callback for single event handling [OK]

Hint: Use once with function callback to run once [OK]

Common Mistakes:

• Using on instead of once for single execution
• Passing function call instead of function
• Expecting multiple logs with once listener