Protected_isProtectedclientOptionaldataProtectedtransportStatic ReadonlycaptureStaticcaptureStaticdefaultStatic Readonlyerrorこのシンボルは、'error'イベントのみを監視するリスナーをインストールするために使用されます。このシンボルを使用してインストールされたリスナーは、通常の'error'リスナーが呼び出される前に呼び出されます。
このシンボルを使用してリスナーをインストールしても、'error'イベントが発行された後の動作は変わりません。したがって、通常の'error'リスナーがインストールされていない場合、プロセスは依然としてクラッシュします。
タブページの番号
現在のタブページが有効かどうか
タブページの現在のウィンドウを取得します
eventNameという名前のイベントに登録された各リスナーを、登録された順に同期的に呼び出し、それぞれの引数を渡します。
イベントにリスナーがあった場合はtrue、そうでない場合はfalseを返します。
const EventEmitter = require('events');
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
Rest...args: any[]エミッターがリスナーを登録したイベントをリストした配列を返します。配列の値は文字列またはSymbolです。
const EventEmitter = require('events');
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
emitter.setMaxListeners(n) で設定されたか、defaultMaxListeners がデフォルトである、EventEmitter の現在の最大リスナー値を返します。
listener関数を、eventNameという名前のイベントのリスナー配列の最後に追加します。listenerが既に追加されているかどうかはチェックされません。同じeventNameとlistenerの組み合わせを渡す複数回の呼び出しは、listenerが複数回追加および呼び出される結果になります。
server.on('connection', (stream) => {
console.log('someone connected!');
});
EventEmitterへの参照を返すため、呼び出しをチェーンできます。
デフォルトでは、イベントリスナーは追加された順序で呼び出されます。emitter.prependListener()メソッドは、イベントリスナーをリスナー配列の先頭に追加する代替手段として使用できます。
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
イベントの名前。
コールバック関数
Rest...args: any[]eventNameという名前のイベントに対して、1回限りのlistener関数を追加します。次回eventNameがトリガーされると、このリスナーは削除されてから呼び出されます。
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
EventEmitterへの参照を返すため、呼び出しをチェーンできます。
デフォルトでは、イベントリスナーは追加された順序で呼び出されます。emitter.prependOnceListener()メソッドは、イベントリスナーをリスナー配列の先頭に追加する代替手段として使用できます。
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
イベントの名前。
コールバック関数
Rest...args: any[]listener関数を、eventNameという名前のイベントのリスナー配列の先頭に追加します。listenerが既に追加されているかどうかはチェックされません。同じeventNameとlistenerの組み合わせを渡す複数回の呼び出しは、listenerが複数回追加および呼び出される結果になります。
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
EventEmitterへの参照を返すため、呼び出しをチェーンできます。
イベントの名前。
コールバック関数
Rest...args: any[]eventNameという名前のイベントに対して、リスナー配列の_先頭_に1回限りのlistener関数を追加します。次回eventNameがトリガーされると、このリスナーは削除されてから呼び出されます。
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
EventEmitterへの参照を返すため、呼び出しをチェーンできます。
イベントの名前。
コールバック関数
Rest...args: any[]eventNameという名前のイベントのリスナー配列のコピーを、(.once()で作成されたものなど)ラッパーを含めて返します。
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');
eventNameという名前のイベントのリスナー配列から指定されたlistenerを削除します。
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener()は、リスナー配列から最大で1つのリスナーインスタンスを削除します。指定されたeventNameのリスナー配列に単一のリスナーが複数回追加されている場合は、各インスタンスを削除するためにremoveListener()を複数回呼び出す必要があります。
イベントが発行されると、発行時にアタッチされていたすべてのリスナーが順番に呼び出されます。これは、発行後、最後のリスナーの実行が完了する前にremoveListener()またはremoveAllListeners()が呼び出されても、それらが実行中のemit()から削除されないことを意味します。後続のイベントは期待どおりに動作します。
const myEmitter = new MyEmitter();
const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};
const callbackB = () => {
console.log('B');
};
myEmitter.on('event', callbackA);
myEmitter.on('event', callbackB);
// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B
// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// A
リスナーは内部配列を使用して管理されているため、これを呼び出すと、削除されるリスナーより後に登録されたリスナーの位置インデックスが変更されます。これは、リスナーが呼び出される順序には影響しませんが、emitter.listeners()メソッドによって返されるリスナー配列のコピーはすべて再作成する必要があることを意味します。
単一の関数が単一のイベントのハンドラーとして複数回追加された場合（以下の例のように）、removeListener()は最も最近追加されたインスタンスを削除します。例では、once('ping')リスナーが削除されます。
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping');
EventEmitterへの参照を返すため、呼び出しをチェーンできます。
Rest...args: any[]StaticgeteventNameという名前のイベントのリスナー配列のコピーを返します。
EventEmitterの場合、これはエミッターで.listenersを呼び出すのとまったく同じように動作します。
EventTargetの場合、これはイベントターゲットのイベントリスナーを取得する唯一の方法です。これは、デバッグと診断の目的に役立ちます。
const { getEventListeners, EventEmitter } = require('events');
{
const ee = new EventEmitter();
const listener = () => console.log('Events are fun');
ee.on('foo', listener);
getEventListeners(ee, 'foo'); // [listener]
}
{
const et = new EventTarget();
const listener = () => console.log('Events are fun');
et.addEventListener('foo', listener);
getEventListeners(et, 'foo'); // [listener]
}
Staticlistener指定されたemitterに登録されている指定されたeventNameのリスナーの数を返すクラスメソッド。
const { EventEmitter, listenerCount } = require('events');
const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
クエリするエミッター
イベント名
Staticonconst { on, EventEmitter } = require('events');
(async () => {
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo')) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();
eventNameイベントを反復処理するAsyncIteratorを返します。EventEmitterが'error'を発行すると、例外をスローします。ループを終了すると、すべてのリスナーが削除されます。各イテレーションによって返されるvalueは、発行されたイベント引数で構成される配列です。
AbortSignalを使用して、イベントの待機をキャンセルできます
const { on, EventEmitter } = require('events');
const ac = new AbortController();
(async () => {
const ee = new EventEmitter();
// Emit later on
process.nextTick(() => {
ee.emit('foo', 'bar');
ee.emit('foo', 42);
});
for await (const event of on(ee, 'foo', { signal: ac.signal })) {
// The execution of this inner block is synchronous and it
// processes one event at a time (even with await). Do not use
// if concurrent execution is required.
console.log(event); // prints ['bar'] [42]
}
// Unreachable here
})();
process.nextTick(() => ac.abort());
リッスンしているイベントの名前
Optionaloptions: StaticEventEmitterOptionsemitterによって発行されたeventNameイベントを反復処理するAsyncIterableIterator<any>を返しますStaticonceEventEmitterが指定されたイベントを発行したときに解決されるPromiseを作成します。または、待機中にEventEmitterが'error'を発行した場合は、拒否されます。Promiseは、指定されたイベントに発行されたすべての引数の配列で解決されます。
このメソッドは意図的にジェネリックであり、特別な'error'イベントセマンティクスがなく、'error'イベントをリッスンしないWebプラットフォームのEventTargetインターフェイスで動作します。
const { once, EventEmitter } = require('events');
async function run() {
const ee = new EventEmitter();
process.nextTick(() => {
ee.emit('myevent', 42);
});
const [value] = await once(ee, 'myevent');
console.log(value);
const err = new Error('kaboom');
process.nextTick(() => {
ee.emit('error', err);
});
try {
await once(ee, 'myevent');
} catch (err) {
console.log('error happened', err);
}
}
run();
'error'イベントの特別な処理は、events.once()が別のイベントを待機するために使用される場合にのみ使用されます。events.once()が'error'イベント自体を待機するために使用される場合、特別な処理なしで他の種類のイベントとして扱われます。
const { EventEmitter, once } = require('events');
const ee = new EventEmitter();
once(ee, 'error')
.then(([err]) => console.log('ok', err.message))
.catch((err) => console.log('error', err.message));
ee.emit('error', new Error('boom'));
// Prints: ok boom
AbortSignalを使用して、イベントの待機をキャンセルできます
const { EventEmitter, once } = require('events');
const ee = new EventEmitter();
const ac = new AbortController();
async function foo(emitter, event, signal) {
try {
await once(emitter, event, { signal });
console.log('event emitted!');
} catch (error) {
if (error.name === 'AbortError') {
console.error('Waiting for the event was canceled!');
} else {
console.error('There was an error', error.message);
}
}
}
foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!
Optionaloptions: StaticEventEmitterOptionsOptionaloptions: StaticEventEmitterOptions
すべてのEventEmitterのデフォルトのcaptureRejection値を設定または取得します。