関数の概要
EventEmitter.listenerCountは、指定されたEventEmitterオブジェクトの特定のイベントに登録されているリスナー(イベントハンドラ)の数を返すNode.jsの関数です。この関数は、イベントに登録されているリスナーの数を知りたいときに使用します。
パラメータの説明
パラメータ | 型 | 用途 |
---|---|---|
emitter | EventEmitter | リスナー数を知りたいEventEmitterオブジェクト |
event | string | リスナー数を知りたいイベントの名前 |
戻り値
戻り値は整数型で、指定されたEventEmitterオブジェクトの指定されたイベントに登録されているリスナーの数を表します。同期的に動作します。
使用例
以下にEventEmitter.listenerCountの使用例を示します。
const EventEmitter = require('events');
const myEmitter = new EventEmitter();
myEmitter.on('event1', () => {
console.log('Event 1 occurred');
});
myEmitter.on('event2', () => {
console.log('Event 2 occurred');
});
console.log(EventEmitter.listenerCount(myEmitter, 'event1')); // Output: 1
関連する関数
EventEmitter.listenerCountと同様の機能を持つ関数として、EventEmitter.listenerCount()、EventEmitter.listeners()があります。
まとめ
EventEmitter.listenerCountは、特定のEventEmitterオブジェクトの特定のイベントに登録されているリスナーの数を返す便利な関数です。イベントの管理やデバッグ時に活用できますが、過剰なリスナー登録には注意が必要です。