【Node.js24.x】EventEmitter::eventNames()メソッドの使い方
eventNamesメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
eventNamesメソッドは、Node.jsのEventEmitterクラスに属し、現在リスナーが登録されているすべてのイベントの名前を文字列の配列として取得するために使用されます。EventEmitterは、特定のイベント（出来事）の発生と、それに対応する処理（リスナー）を管理するための仕組みを提供するクラスです。
このeventNamesメソッドを呼び出すことで、対象のEventEmitterインスタンスが現在監視している、または反応する準備ができているイベントのリストを把握することができます。例えば、複数のイベントを動的に登録・解除するアプリケーションにおいて、現在どのイベントに対して処理が割り当てられているかを一覧で確認したい場合に非常に役立ちます。これにより、プログラムがどのようなイベントに応答可能であるか、その現在の状態を容易に把握できます。
返される配列には、各イベント名が一意に格納されており、重複することはありません。もし、どのイベントにもリスナーが登録されていない場合には、空の配列が返されます。このメソッドは、プログラムの現在のイベント処理の状態を把握し、デバッグや動的なイベント管理を行う際に非常に重要な情報を提供します。
構文(syntax)
1const EventEmitter = require('events'); 2const myEmitter = new EventEmitter(); 3 4myEmitter.on('userLoggedIn', () => {}); 5myEmitter.on('dataReceived', () => {}); 6 7const registeredEventNames = myEmitter.eventNames(); 8console.log(registeredEventNames);
引数(parameters)
引数なし
引数はありません
戻り値(return)
Array<string | symbol>
このメソッドは、EventEmitterインスタンスが現在登録している全てのイベントリスナーの名前を配列として返します。イベントリスナーの名前は文字列またはシンボルで表されます。