Once listeners in Node.js - Step-by-Step Execution

Concept Flow - Once listeners

Create EventEmitter

↓

Add once listener

↓

Emit event

↓

Listener runs

↓

Listener removed automatically

↓

Emit event again

↓

No listener runs

↓

END

This flow shows how a once listener is added, runs only once when the event emits, then is removed automatically.

Execution Sample

Node.js

const EventEmitter = require('events');
const emitter = new EventEmitter();
emitter.once('greet', () => console.log('Hello!'));
emitter.emit('greet');
emitter.emit('greet');

This code adds a once listener to 'greet' event, emits it twice, but the listener runs only the first time.

Execution Table

Step	Action	Listener Count for 'greet'	Output	Notes
1	Create EventEmitter instance	0		No listeners yet
2	Add once listener for 'greet'	1		Listener added, will run once
3	Emit 'greet' event first time	0	Hello!	Listener runs and then is removed
4	Listener removed automatically	0		No listeners remain for 'greet'
5	Emit 'greet' event second time	0		No listener runs this time

💡 No listeners remain after first emit, so second emit does nothing

Variable Tracker

Variable	Start	After Step 2	After Step 3	After Step 4	After Step 5
emitter.listenerCount('greet')	0	1	0	0	0

Key Moments - 2 Insights

Why does the listener not run the second time the event is emitted?

Because the listener was added with 'once', it automatically removes itself after running once, as shown in execution_table step 4.

Does the listener get removed before or after it runs on the first emit?

The listener runs first, then is removed immediately after, as shown in execution_table step 3 and 4.

Visual Quiz - 3 Questions

Look at the execution table, what is the listener count for 'greet' after the first emit?

A 1

B 2

C 0

D Cannot tell

💡 Hint

Check the 'Listener Count for greet' column at step 4 in the execution table.

At which step does the listener get removed automatically?

A Step 3

B Step 4

C Step 2

D Step 5

💡 Hint

Look at the 'Notes' column describing listener removal in the execution table.

If we replaced 'once' with 'on', what would happen on the second emit?

A Listener runs again

B Listener runs only once

C Listener is removed automatically

D No listener runs

💡 Hint

Refer to the concept flow where 'once' removes listener after first run; 'on' keeps it.

Concept Snapshot

EventEmitter.once(event, listener) adds a listener that runs only once.
When the event emits, the listener runs and is removed automatically.
Subsequent emits of the same event do not trigger the listener.
Use once for one-time event handling.
Listener count decreases after first emit.

Full Transcript

In Node.js, the EventEmitter class allows adding listeners that respond to events. Using the 'once' method adds a listener that runs only the first time the event is emitted. When the event is emitted, the listener runs and then removes itself automatically. If the event is emitted again, the listener does not run because it no longer exists. This behavior is useful for handling events that should only trigger a single time. The execution table shows the listener count starting at zero, increasing to one when added, running on the first emit, then dropping back to zero after removal. The second emit finds no listener and produces no output.

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