【Node.js24.x】EventEmitter::removeAllListeners()メソッドの使い方

removeAllListenersメソッドは、Node.jsのEventEmitterクラスのインスタンスに登録されているイベントリスナーを効率的に削除するために使用されるメソッドです。このメソッドは、特定のイベントに紐づく全てのリスナー、あるいはインスタンスに登録されている全てのイベントタイプに対するリスナーを一度に解除する機能を提供します。

引数としてeventName（イベント名）を指定した場合、そのイベント名に関連付けられた全てのリスナーが削除されます。例えば、myEmitter.removeAllListeners('data')と記述すると、myEmitterオブジェクトが発火するdataイベントに登録されているすべての処理が削除されることになります。これは、特定のイベントに対するハンドリングが不要になった際に、関連するリスナーだけをクリーンアップしたい場合に便利です。

一方、引数を一切指定せずにmyEmitter.removeAllListeners()のように呼び出した場合、そのEventEmitterインスタンスに登録されている、あらゆるイベントタイプ（例えば、data、error、endなど）のすべてのリスナーがまとめて削除されます。この機能は、オブジェクトがライフサイクルを終える際や、システム全体でイベント処理を停止するような場面で、メモリリークを防ぎ、リソースを適切に解放するために非常に重要です。

このメソッドは、呼び出し元のEventEmitterインスタンス自身を返します。システムエンジニアにとって、イベント駆動型プログラミングにおけるリスナーの適切な追加と削除は、安定したアプリケーションの性能と信頼性を維持するために不可欠な知識です。

Copy
1const EventEmitter = require('events');
2const myEmitter = new EventEmitter();
3
4myEmitter.on('myCustomEvent', () => {
5  console.log('This listener for myCustomEvent will be removed.');
6});
7
8myEmitter.on('anotherEvent', () => {
9  console.log('This listener for anotherEvent will remain.');
10});
11
12myEmitter.removeAllListeners('myCustomEvent');
13
14myEmitter.emit('myCustomEvent');
15myEmitter.emit('anotherEvent');

eventName = undefined

• eventName: string | symbol | undefined: 削除するリスナーのイベント名を指定します。指定しない場合、すべてのイベントリスナーが削除されます。

EventEmitter

このメソッドは、イベントリスナーをすべて削除したEventEmitterオブジェクト自身を返します。これにより、メソッドチェーンで続けて他の操作を行うことが可能です。