関数の概要
EventEmitter.onceは、Node.jsで提供されるイベント駆動型のモジュールであり、特定のイベントが一度だけ発生した時にコールバック関数を実行するためのメソッドです。例えば、特定のイベントが初めて発生した時に何か処理を行いたい場合に利用します。
パラメータの説明
| パラメータ | 型 | 用途 |
|---|---|---|
| event | String | 発生するイベントの名前を指定 |
| listener | Function | イベントが発生した時に実行されるコールバック関数を指定 |
戻り値
EventEmitter.onceは特定のイベントが初めて発生した時に一度だけコールバック関数を実行し、その後は同じイベントに対するリスナーが削除されます。
使用例
以下に、EventEmitter.onceの使用例を示します。
const { EventEmitter } = require('events');
const myEmitter = new EventEmitter();
myEmitter.once('greet', () => {
console.log('Hello!');
});
myEmitter.emit('greet'); // 'Hello!'が出力される
myEmitter.emit('greet'); // 何も出力されない
関連する関数
EventEmitter.on: 同じイベントに対して複数回リスナーを登録する際に使用
まとめ
EventEmitter.onceは、特定のイベントが初めて発生した時に一度だけ実行されるコールバック関数を登録する際に利用されます。注意点として、登録したコールバック関数は一度実行された後は自動的に削除されるため、複数回実行したい場合は適切な方法を考える必要があります。
