【Node.js24.x】EventEmitter::emit()メソッドの使い方
emitメソッドの使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
emitメソッドは、Node.jsのEventEmitterクラスに属し、登録されたイベントリスナー関数を呼び出すために使用されるメソッドです。このメソッドは、EventEmitterインスタンス上で特定のイベントを発生させる役割を担います。emitメソッドが呼び出されると、最初の引数として指定されたイベント名に紐づけられたすべてのリスナー関数が、引数として渡された追加のデータとともに、定義された順序で同期的に実行されます。
具体的な使い方としては、まず最初の引数に発生させたいイベントの文字列名を渡します。その後に続く引数は、そのイベントに関連するデータとして、リスナー関数に直接渡されます。例えば、ユーザーがログインしたというイベントや、データが完全に読み込まれたというイベントなど、プログラム内で特定の出来事が発生したことを他の部分に通知する際に非常に役立ちます。
emitメソッドは、指定されたイベントに対して一つでもリスナーが存在している場合はtrueを、リスナーが一つも登録されていない場合はfalseを返します。これにより、イベントが適切に処理されたかどうかを簡易的に確認することも可能です。Node.jsにおける非同期処理やモジュール間の疎結合な連携を実現する上で、EventEmitterのemitメソッドはイベント駆動プログラミングの基礎として広く利用されています。
構文(syntax)
1const EventEmitter = require('events'); 2const myEmitter = new EventEmitter(); 3 4myEmitter.emit('eventName', /* arg1, arg2, ... */);
引数(parameters)
type, ...args
- type: string: 発行するイベントのタイプを指定します。
- ...args: emit されるイベントに渡す追加の引数です。
戻り値(return)
boolean
指定されたイベントリスナーが登録されており、イベントが正常に発行された場合はtrueを返します。それ以外の場合はfalseを返します。