関数の概要
EventEmitter.onは、Node.jsのEventEmitterクラスのメソッドの1つです。この関数は、特定のイベント(例えば、”click”や”submit”など)が発生した時に、そのイベントに対するコールバック関数を登録するために使用します。イベントが発生した際に登録されたコールバック関数が実行される仕組みを提供します。
パラメータの説明
パラメータ | 型 | 用途 |
---|---|---|
eventName | String | 登録するイベントの名前を指定 |
listener | Function | 指定したイベントが発生した時に実行されるコールバック関数を指定 |
戻り値
特に指定された戻り値はなく、非同期的にイベントを受け取ります。
使用例
以下にEventEmitter.onの使用例を示します。
const EventEmitter = require('events');
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {
console.log('イベントが発生しました!');
});
myEmitter.emit('event');
// 出力: イベントが発生しました!
関連する関数
EventEmitter.once、EventEmitter.emitなど、EventEmitterクラスの他の関数があります。
まとめ
EventEmitter.onは特定のイベントが発生した時に実行するコールバック関数を登録するための関数です。イベント駆動型のプログラミングでよく使用されますが、イベントを適切に登録しないと正しく動作しないので注意が必要です。