Share via

Twin class

  • ‏‏المرجع
الحزمة:
azure-iot-device

Device Twin هو مستند يصف حالة الجهاز المخزن بواسطة مركز Azure IoT وهو متاح حتى إذا كان الجهاز غير متصل. وهو مبني حول 3 أقسام:

  • العلامات: أزواج المفاتيح/القيمة التي يمكن الوصول إليها فقط من جانب الخدمة
  • الخصائص المطلوبة: تم تحديثها بواسطة خدمة وتلقيها من قبل الجهاز
  • الخصائص المبلغ عنها: تم تحديثها بواسطة الجهاز وتلقيها بواسطة الخدمة.

لاحظ أنه على الرغم من أنه احتمال، لا يجب أن تتطابق الخصائص المطلوبة والمبلغ عنها وأن المنطق لمزامنة هاتين المجموعتين، إذا لزم الأمر، يترك لمستخدم SDK.

لمزيد من المعلومات، راجع فهم Device Twins.

Extends

EventEmitter

الخصائص

desiredPath
errorEvent
properties

قواميس الخصائص المطلوبة والمبلغ عنها (على التوالي في properties.desired و properties.reported).
userRegisteredDesiredPropertiesListener

الخصائص الموروثة

captureRejections

القيمة: منطقية

تغيير الخيار الافتراضي captureRejections على كافة الكائنات الجديدة EventEmitter .
captureRejectionSymbol

القيمة: Symbol.for('nodejs.rejection')

تعرف على كيفية كتابة مخصص rejection handler.
defaultMaxListeners

بشكل افتراضي، يمكن تسجيل الحد الأقصى من 10 المستمعين لأي حدث واحد. يمكن تغيير هذا الحد للمثيلات الفردية EventEmitter باستخدام emitter.setMaxListeners(n) الأسلوب . لتغيير الإعداد الافتراضي لكافةEventEmitter المثيلات، يمكن استخدام الخاصية events.defaultMaxListeners . إذا لم تكن هذه القيمة رقما موجبا، RangeError يتم طرح .

كن حذرا عند تعيين events.defaultMaxListeners لأن التغيير يؤثر على جميعEventEmitter المثيلات، بما في ذلك تلك التي تم إنشاؤها قبل إجراء التغيير. ومع ذلك، لا يزال الاستدعاء emitter.setMaxListeners(n) له الأسبقية على events.defaultMaxListeners.

هذا ليس حدا صعبا. سيسمح المثيل EventEmitter بإضافة المزيد من المستمعين ولكنه سيخرج تحذير تتبع إلى stderr يشير إلى أنه تم الكشف عن "تسرب محتمل لذاكرة EventEmitter". بالنسبة لأي واحد EventEmitter، يمكن استخدام الأسلوبين emitter.getMaxListeners() و emitter.setMaxListeners() لتجنب هذا التحذير مؤقتا:

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});

--trace-warnings يمكن استخدام علامة سطر الأوامر لعرض تتبع المكدس لمثل هذه التحذيرات.

يمكن فحص التحذير المنبعث باستخدام process.on('warning') و سيكون له خصائص و و count إضافيةemittertype، في إشارة إلى مثيل باعث الحدث واسم الحدث وعدد المستمعين المرفقين، على التوالي. name تم تعيين الخاصية الخاصة به إلى 'MaxListenersExceededWarning'.
errorMonitor

يجب استخدام هذا الرمز لتثبيت وحدة استماع لمراقبة 'error' الأحداث فقط. يتم استدعاء وحدات الاستماع المثبتة باستخدام هذا الرمز قبل استدعاء المستمعين العاديين 'error' .

لا يؤدي تثبيت وحدة استماع باستخدام هذا الرمز إلى تغيير السلوك بمجرد 'error' إصدار حدث. لذلك، ستستمر العملية في التعطل إذا لم يتم تثبيت وحدة استماع عادية 'error' .

الأساليب

get()
get(Callback<Twin>)

يحصل على التوأم بأكمله من الخدمة.

الأساليب المتوارثة

addAbortListener(AbortSignal, (event: Event) => void)

يستمع مرة واحدة إلى abort الحدث على المقدم signal.

الاستماع إلى abort الحدث على إشارات إحباط غير آمن وقد يؤدي إلى تسرب الموارد حيث يمكن لجهة خارجية أخرى مع الإشارة استدعاء e.stopImmediatePropagation(). للأسف Node.js لا يمكن تغيير هذا لأنه من شأنه أن ينتهك معيار الويب. بالإضافة إلى ذلك، تسهل واجهة برمجة التطبيقات الأصلية نسيان إزالة المستمعين.

تسمح واجهة برمجة التطبيقات هذه باستخدام AbortSignals بأمان في واجهات برمجة التطبيقات Node.js عن طريق حل هاتين المشكلتين عن طريق الاستماع إلى الحدث بحيث stopImmediatePropagation لا يمنع وحدة الاستماع من التشغيل.

إرجاع يمكن التخلص منه بحيث يمكن إلغاء اشتراكه من بسهولة أكبر.

import { addAbortListener } from 'node:events';

function example(signal) {
  let disposable;
  try {
    signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
    disposable = addAbortListener(signal, (e) => {
      // Do something when signal is aborted.
    });
  } finally {
    disposable?.[Symbol.dispose]();
  }
}
addListener<K>(string | symbol, (args: any[]) => void)

الاسم المستعار ل emitter.on(eventName, listener).
emit<K>(string | symbol, AnyRest)

يستدعي بشكل متزامن كل من المستمعين المسجلين للحدث المسمى eventName، بالترتيب الذي تم تسجيله، ما يمرر الوسيطات المتوفرة لكل منها.

إرجاع true إذا كان الحدث يحتوي على مستمعين، false بخلاف ذلك.

import { EventEmitter } from 'node: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
eventNames()

إرجاع صفيف يسرد الأحداث التي لدى المرسل مستمعين مسجلين لها. القيم في الصفيف هي سلاسل أو Symbols.

import { EventEmitter } from 'node: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) ]
getEventListeners(EventEmitter<DefaultEventMap> | EventTarget, string | symbol)

إرجاع نسخة من صفيف المستمعين للحدث المسمى eventName.

لأن EventEmitterهذا يتصرف تماما نفس استدعاء .listeners على الباعث.

بالنسبة إلى EventTargets، هذه هي الطريقة الوحيدة للحصول على مستمعي الحدث لهدف الحدث. هذا مفيد لأغراض تصحيح الأخطاء والتشخيص.

import { getEventListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  const listener = () => console.log('Events are fun');
  ee.on('foo', listener);
  console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
  const et = new EventTarget();
  const listener = () => console.log('Events are fun');
  et.addEventListener('foo', listener);
  console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}
getMaxListeners()

إرجاع الحد الأقصى الحالي لقيمة EventEmitter وحدة الاستماع التي يتم تعيينها إما حسب emitter.setMaxListeners(n) أو الإعدادات الافتراضية إلى defaultMaxListeners.
getMaxListeners(EventEmitter<DefaultEventMap> | EventTarget)

إرجاع الحد الأقصى المعين حاليا لمقدار المستمعين.

لأن EventEmitterهذا يتصرف تماما نفس استدعاء .getMaxListeners على الباعث.

بالنسبة إلى EventTargets، هذه هي الطريقة الوحيدة للحصول على الحد الأقصى لمستمعي الأحداث لهدف الحدث. إذا تجاوز عدد معالجات الأحداث على EventTarget واحد الحد الأقصى لمجموعة الأحداث، فسيطبع EventTarget تحذيرا.

import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  console.log(getMaxListeners(ee)); // 10
  setMaxListeners(11, ee);
  console.log(getMaxListeners(ee)); // 11
}
{
  const et = new EventTarget();
  console.log(getMaxListeners(et)); // 10
  setMaxListeners(11, et);
  console.log(getMaxListeners(et)); // 11
}
listenerCount(EventEmitter<DefaultEventMap>, string | symbol)

أسلوب فئة يقوم بإرجاع عدد المستمعين للمقدم eventName المسجل في المحدد emitter.

import { EventEmitter, listenerCount } from 'node:events';

const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2
listenerCount<K>(string | symbol, Function)

إرجاع عدد المستمعين الذين يستمعون للحدث المسمى eventName. إذا listener تم توفيره، فسيرجع عدد المرات التي يتم فيها العثور على وحدة الإصغاء في قائمة مستمعي الحدث.
listeners<K>(string | symbol)

إرجاع نسخة من صفيف المستمعين للحدث المسمى eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
off<K>(string | symbol, (args: any[]) => void)

الاسم المستعار ل emitter.removeListener().
on(EventEmitter<DefaultEventMap>, string, StaticEventEmitterOptions) 
import { on, EventEmitter } from 'node:events';
import process from 'node:process';

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

AsyncIterator إرجاع الذي يكرر eventName الأحداث. سيرمي إذا EventEmitter انبعث 'error'. يزيل جميع المستمعين عند الخروج من الحلقة. الذي value يتم إرجاعه بواسطة كل تكرار هو صفيف يتكون من وسيطات الحدث المنبعثة.

AbortSignal يمكن استخدام لإلغاء انتظار الأحداث:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

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());
on<K>(string | symbol, (args: any[]) => void)

يضيف الدالة listener إلى نهاية صفيف المستمعين للحدث المسمى eventName. لا يتم إجراء أي عمليات فحص لمعرفة ما إذا كان listener قد تمت إضافته بالفعل. ستؤدي المكالمات المتعددة التي تمرر نفس المجموعة من eventName و listener إلى listener إضافة واستدعاء عدة مرات.

server.on('connection', (stream) => {
  console.log('someone connected!');
});

إرجاع مرجع إلى EventEmitter، بحيث يمكن ربط الاستدعاءات.

بشكل افتراضي، يتم استدعاء مستمعي الأحداث بالترتيب الذي تتم إضافتهم به. emitter.prependListener() يمكن استخدام الأسلوب كبديل لإضافة مستمع الحدث إلى بداية صفيف المستمعين.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a
once(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterOptions)

Promise ينشئ الذي يتم تنفيذه عند EventEmitter إصدار الحدث المحدد أو الذي يتم رفضه إذا EventEmitter تم إصداره 'error' أثناء الانتظار. Promise سيتم حل مع صفيف من جميع الوسيطات المنبعثة إلى الحدث المحدد.

هذه الطريقة عامة عمدا وتعمل مع واجهة EventTarget للنظام الأساسي على الويب، والتي لا تحتوي على دلالات حدث خاص'error' ولا تستمع إلى 'error' الحدث.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

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.error('error happened', err);
}

يتم استخدام المعالجة الخاصة للحدث 'error' فقط عند events.once() استخدامها لانتظار حدث آخر. إذا events.once() تم استخدام لانتظار الحدث نفسهerror' ، فسيتم التعامل معه كأي نوع آخر من الأحداث دون معالجة خاصة:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.error('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

AbortSignal يمكن استخدام لإلغاء انتظار الحدث:

import { EventEmitter, once } from 'node: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!
once(EventTarget, string, StaticEventEmitterOptions)
once<K>(string | symbol, (args: any[]) => void)

يضيف دالة لمرةlistener واحدة للحدث المسمى eventName. في المرة eventName التالية التي يتم فيها تشغيل، تتم إزالة وحدة الاستماع هذه ثم استدعاؤها.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

إرجاع مرجع إلى EventEmitter، بحيث يمكن ربط الاستدعاءات.

بشكل افتراضي، يتم استدعاء مستمعي الأحداث بالترتيب الذي تتم إضافتهم به. emitter.prependOnceListener() يمكن استخدام الأسلوب كبديل لإضافة مستمع الحدث إلى بداية صفيف المستمعين.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a
prependListener<K>(string | symbol, (args: any[]) => void)

يضيف الدالة listener إلى بداية صفيف المستمعين للحدث المسمى eventName. لا يتم إجراء أي عمليات فحص لمعرفة ما إذا كان listener قد تمت إضافته بالفعل. ستؤدي المكالمات المتعددة التي تمرر نفس المجموعة من eventName و listener إلى listener إضافة واستدعاء عدة مرات.

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

إرجاع مرجع إلى EventEmitter، بحيث يمكن ربط الاستدعاءات.
prependOnceListener<K>(string | symbol, (args: any[]) => void)

يضيف دالة لمرةlistener واحدة للحدث المسمى eventName إلى بداية صفيف المستمعين. في المرة eventName التالية التي يتم فيها تشغيل، تتم إزالة وحدة الاستماع هذه، ثم استدعاؤها.

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

إرجاع مرجع إلى EventEmitter، بحيث يمكن ربط الاستدعاءات.
rawListeners<K>(string | symbol)

إرجاع نسخة من صفيف المستمعين للحدث المسمى eventName، بما في ذلك أي برامج تضمين (مثل تلك التي تم إنشاؤها بواسطة .once()).

import { EventEmitter } from 'node:events';
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');
removeAllListeners(string | symbol)

يزيل جميع المستمعين أو المستمعين المحددين eventName.

من الممارسات السيئة إزالة المستمعين الذين تمت إضافتهم في مكان آخر في التعليمات البرمجية، خاصة عندما EventEmitter تم إنشاء المثيل بواسطة بعض المكونات أو الوحدة النمطية الأخرى (مثل مآخذ التوصيل أو تدفقات الملفات).

إرجاع مرجع إلى EventEmitter، بحيث يمكن ربط الاستدعاءات.
removeListener<K>(string | symbol, (args: any[]) => void)

يزيل المحدد listener من صفيف وحدة الاستماع للحدث المسمى eventName.

const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() سيزيل، على الأكثر، مثيلا واحدا من وحدة الاستماع من صفيف المستمع. إذا تمت إضافة أي وحدة استماع واحدة عدة مرات إلى صفيف المستمع للمحدد eventName، removeListener() فيجب استدعاء عدة مرات لإزالة كل مثيل.

بمجرد إصدار حدث، يتم استدعاء جميع المستمعين المرفقين به في وقت الانبعاث بالترتيب. وهذا يعني أن أي removeListener() أو removeAllListeners()استدعاءات بعد الانبعاث وقبل انتهاء المستمع الأخير من التنفيذ لن يزيلها منemit() قيد التقدم. تتصرف الأحداث اللاحقة كما هو متوقع.

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
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') الاستماع:

import { EventEmitter } from 'node:events';
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، بحيث يمكن ربط الاستدعاءات.
setMaxListeners(number)

بشكل افتراضي EventEmitter، سيطبع s تحذيرا إذا تمت إضافة أكثر من 10 وحدات الاستماع لحدث معين. هذا افتراضي مفيد يساعد على العثور على تسربات الذاكرة. emitter.setMaxListeners() يسمح الأسلوب بتعديل الحد لهذا المثيل المحددEventEmitter. يمكن تعيين القيمة إلى Infinity (أو 0) للإشارة إلى عدد غير محدود من المستمعين.

إرجاع مرجع إلى EventEmitter، بحيث يمكن ربط الاستدعاءات.
setMaxListeners(number, (EventEmitter<DefaultEventMap> | EventTarget)[]) 
import { setMaxListeners, EventEmitter } from 'node:events';

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);
[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)

تفاصيل الخاصية

desiredPath 

static desiredPath: string

قيمة الخاصية

string

errorEvent 

static errorEvent: string

قيمة الخاصية

string

properties

قواميس الخصائص المطلوبة والمبلغ عنها (على التوالي في properties.desired و properties.reported).

properties: TwinProperties

قيمة الخاصية

TwinProperties

userRegisteredDesiredPropertiesListener 

userRegisteredDesiredPropertiesListener: boolean

قيمة الخاصية

boolean

تفاصيل الخاصية الموروثة

captureRejections

القيمة: منطقية

تغيير الخيار الافتراضي captureRejections على كافة الكائنات الجديدة EventEmitter .

static captureRejections: boolean

قيمة الخاصية

boolean

موروث من EventEmitter.captureRejections

captureRejectionSymbol

القيمة: Symbol.for('nodejs.rejection')

تعرف على كيفية كتابة مخصص rejection handler.

static captureRejectionSymbol: typeof captureRejectionSymbol

قيمة الخاصية

typeof captureRejectionSymbol

موروث من EventEmitter.captureRejectionSymbol

defaultMaxListeners

بشكل افتراضي، يمكن تسجيل الحد الأقصى من 10 المستمعين لأي حدث واحد. يمكن تغيير هذا الحد للمثيلات الفردية EventEmitter باستخدام emitter.setMaxListeners(n) الأسلوب . لتغيير الإعداد الافتراضي لكافةEventEmitter المثيلات، يمكن استخدام الخاصية events.defaultMaxListeners . إذا لم تكن هذه القيمة رقما موجبا، RangeError يتم طرح .

كن حذرا عند تعيين events.defaultMaxListeners لأن التغيير يؤثر على جميعEventEmitter المثيلات، بما في ذلك تلك التي تم إنشاؤها قبل إجراء التغيير. ومع ذلك، لا يزال الاستدعاء emitter.setMaxListeners(n) له الأسبقية على events.defaultMaxListeners.

هذا ليس حدا صعبا. سيسمح المثيل EventEmitter بإضافة المزيد من المستمعين ولكنه سيخرج تحذير تتبع إلى stderr يشير إلى أنه تم الكشف عن "تسرب محتمل لذاكرة EventEmitter". بالنسبة لأي واحد EventEmitter، يمكن استخدام الأسلوبين emitter.getMaxListeners() و emitter.setMaxListeners() لتجنب هذا التحذير مؤقتا:

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});

--trace-warnings يمكن استخدام علامة سطر الأوامر لعرض تتبع المكدس لمثل هذه التحذيرات.

يمكن فحص التحذير المنبعث باستخدام process.on('warning') و سيكون له خصائص و و count إضافيةemittertype، في إشارة إلى مثيل باعث الحدث واسم الحدث وعدد المستمعين المرفقين، على التوالي. name تم تعيين الخاصية الخاصة به إلى 'MaxListenersExceededWarning'.

static defaultMaxListeners: number

قيمة الخاصية

number

موروث من EventEmitter.defaultMaxListeners

errorMonitor

يجب استخدام هذا الرمز لتثبيت وحدة استماع لمراقبة 'error' الأحداث فقط. يتم استدعاء وحدات الاستماع المثبتة باستخدام هذا الرمز قبل استدعاء المستمعين العاديين 'error' .

لا يؤدي تثبيت وحدة استماع باستخدام هذا الرمز إلى تغيير السلوك بمجرد 'error' إصدار حدث. لذلك، ستستمر العملية في التعطل إذا لم يتم تثبيت وحدة استماع عادية 'error' .

static errorMonitor: typeof errorMonitor

قيمة الخاصية

typeof errorMonitor

موروث من EventEmitter.errorMonitor

تفاصيل الأسلوب

get() 

function get(): Promise<Twin>

المرتجعات

Promise<Twin>

get(Callback<Twin>)

يحصل على التوأم بأكمله من الخدمة.

function get(callback?: Callback<Twin>)

المعلمات

callback

Callback<Twin>

الدالة الاختيارية التي يجب استدعاؤها مرة أخرى مع التوأم أو خطأ إذا فشل النقل في استرداد التوأم.

تفاصيل الأساليب المتوارثة

addAbortListener(AbortSignal, (event: Event) => void)

يستمع مرة واحدة إلى abort الحدث على المقدم signal.

الاستماع إلى abort الحدث على إشارات إحباط غير آمن وقد يؤدي إلى تسرب الموارد حيث يمكن لجهة خارجية أخرى مع الإشارة استدعاء e.stopImmediatePropagation(). للأسف Node.js لا يمكن تغيير هذا لأنه من شأنه أن ينتهك معيار الويب. بالإضافة إلى ذلك، تسهل واجهة برمجة التطبيقات الأصلية نسيان إزالة المستمعين.

تسمح واجهة برمجة التطبيقات هذه باستخدام AbortSignals بأمان في واجهات برمجة التطبيقات Node.js عن طريق حل هاتين المشكلتين عن طريق الاستماع إلى الحدث بحيث stopImmediatePropagation لا يمنع وحدة الاستماع من التشغيل.

إرجاع يمكن التخلص منه بحيث يمكن إلغاء اشتراكه من بسهولة أكبر.

import { addAbortListener } from 'node:events';

function example(signal) {
  let disposable;
  try {
    signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
    disposable = addAbortListener(signal, (e) => {
      // Do something when signal is aborted.
    });
  } finally {
    disposable?.[Symbol.dispose]();
  }
}

static function addAbortListener(signal: AbortSignal, resource: (event: Event) => void): Disposable

المعلمات

signal

AbortSignal

resource

(event: Event) => void

المرتجعات

Disposable

يمكن التخلص منه الذي يزيل وحدة abort الإصغاء.

موروث من EventEmitter.addAbortListener

addListener<K>(string | symbol, (args: any[]) => void)

الاسم المستعار ل emitter.on(eventName, listener).

function addListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

المعلمات

eventName

string | symbol

listener

(args: any[]) => void

المرتجعات

Twin

موروث من EventEmitter.addListener

emit<K>(string | symbol, AnyRest)

يستدعي بشكل متزامن كل من المستمعين المسجلين للحدث المسمى eventName، بالترتيب الذي تم تسجيله، ما يمرر الوسيطات المتوفرة لكل منها.

إرجاع true إذا كان الحدث يحتوي على مستمعين، false بخلاف ذلك.

import { EventEmitter } from 'node: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

function emit<K>(eventName: string | symbol, args: AnyRest): boolean

المعلمات

eventName

string | symbol

args

AnyRest

المرتجعات

boolean

موروث من EventEmitter.emit

eventNames()

إرجاع صفيف يسرد الأحداث التي لدى المرسل مستمعين مسجلين لها. القيم في الصفيف هي سلاسل أو Symbols.

import { EventEmitter } from 'node: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) ]

function eventNames(): (string | symbol)[]

المرتجعات

(string | symbol)[]

موروث من EventEmitter.eventNames

getEventListeners(EventEmitter<DefaultEventMap> | EventTarget, string | symbol)

إرجاع نسخة من صفيف المستمعين للحدث المسمى eventName.

لأن EventEmitterهذا يتصرف تماما نفس استدعاء .listeners على الباعث.

بالنسبة إلى EventTargets، هذه هي الطريقة الوحيدة للحصول على مستمعي الحدث لهدف الحدث. هذا مفيد لأغراض تصحيح الأخطاء والتشخيص.

import { getEventListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  const listener = () => console.log('Events are fun');
  ee.on('foo', listener);
  console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
  const et = new EventTarget();
  const listener = () => console.log('Events are fun');
  et.addEventListener('foo', listener);
  console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}

static function getEventListeners(emitter: EventEmitter<DefaultEventMap> | EventTarget, name: string | symbol): Function[]

المعلمات

emitter

EventEmitter<DefaultEventMap> | EventTarget

name

string | symbol

المرتجعات

Function[]

موروث من EventEmitter.getEventListeners

getMaxListeners()

إرجاع الحد الأقصى الحالي لقيمة EventEmitter وحدة الاستماع التي يتم تعيينها إما حسب emitter.setMaxListeners(n) أو الإعدادات الافتراضية إلى defaultMaxListeners.

function getMaxListeners(): number

المرتجعات

number

موروث من EventEmitter.getMaxListeners

getMaxListeners(EventEmitter<DefaultEventMap> | EventTarget)

إرجاع الحد الأقصى المعين حاليا لمقدار المستمعين.

لأن EventEmitterهذا يتصرف تماما نفس استدعاء .getMaxListeners على الباعث.

بالنسبة إلى EventTargets، هذه هي الطريقة الوحيدة للحصول على الحد الأقصى لمستمعي الأحداث لهدف الحدث. إذا تجاوز عدد معالجات الأحداث على EventTarget واحد الحد الأقصى لمجموعة الأحداث، فسيطبع EventTarget تحذيرا.

import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  console.log(getMaxListeners(ee)); // 10
  setMaxListeners(11, ee);
  console.log(getMaxListeners(ee)); // 11
}
{
  const et = new EventTarget();
  console.log(getMaxListeners(et)); // 10
  setMaxListeners(11, et);
  console.log(getMaxListeners(et)); // 11
}

static function getMaxListeners(emitter: EventEmitter<DefaultEventMap> | EventTarget): number

المعلمات

emitter

EventEmitter<DefaultEventMap> | EventTarget

المرتجعات

number

موروث من EventEmitter.getMaxListeners

listenerCount(EventEmitter<DefaultEventMap>, string | symbol)

تحذير

واجهة برمجة التطبيقات هذه مهملة الآن.

Since v3.2.0 - Use listenerCount instead.

أسلوب فئة يقوم بإرجاع عدد المستمعين للمقدم eventName المسجل في المحدد emitter.

import { EventEmitter, listenerCount } from 'node:events';

const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2

static function listenerCount(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol): number

المعلمات

emitter

EventEmitter<DefaultEventMap>

الباعث للاستعلام

eventName

string | symbol

اسم الحدث

المرتجعات

number

موروث من EventEmitter.listenerCount

listenerCount<K>(string | symbol, Function)

إرجاع عدد المستمعين الذين يستمعون للحدث المسمى eventName. إذا listener تم توفيره، فسيرجع عدد المرات التي يتم فيها العثور على وحدة الإصغاء في قائمة مستمعي الحدث.

function listenerCount<K>(eventName: string | symbol, listener?: Function): number

المعلمات

eventName

string | symbol

اسم الحدث الذي يتم الاستماع إليه

listener

Function

دالة معالج الأحداث

المرتجعات

number

موروث من EventEmitter.listenerCount

listeners<K>(string | symbol)

إرجاع نسخة من صفيف المستمعين للحدث المسمى eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

function listeners<K>(eventName: string | symbol): Function[]

المعلمات

eventName

string | symbol

المرتجعات

Function[]

موروث من EventEmitter.listeners

off<K>(string | symbol, (args: any[]) => void)

الاسم المستعار ل emitter.removeListener().

function off<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

المعلمات

eventName

string | symbol

listener

(args: any[]) => void

المرتجعات

Twin

موروث من EventEmitter.off

on(EventEmitter<DefaultEventMap>, string, StaticEventEmitterOptions) 

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

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

AsyncIterator إرجاع الذي يكرر eventName الأحداث. سيرمي إذا EventEmitter انبعث 'error'. يزيل جميع المستمعين عند الخروج من الحلقة. الذي value يتم إرجاعه بواسطة كل تكرار هو صفيف يتكون من وسيطات الحدث المنبعثة.

AbortSignal يمكن استخدام لإلغاء انتظار الأحداث:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

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());

static function on(emitter: EventEmitter<DefaultEventMap>, eventName: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

المعلمات

emitter

EventEmitter<DefaultEventMap>

eventName

string

اسم الحدث الذي يتم الاستماع إليه

options

StaticEventEmitterOptions

المرتجعات

AsyncIterableIterator<any>

AsyncIterator الذي يكرر eventName الأحداث المنبعثة منemitter

موروث من EventEmitter.on

on<K>(string | symbol, (args: any[]) => void)

يضيف الدالة listener إلى نهاية صفيف المستمعين للحدث المسمى eventName. لا يتم إجراء أي عمليات فحص لمعرفة ما إذا كان listener قد تمت إضافته بالفعل. ستؤدي المكالمات المتعددة التي تمرر نفس المجموعة من eventName و listener إلى listener إضافة واستدعاء عدة مرات.

server.on('connection', (stream) => {
  console.log('someone connected!');
});

إرجاع مرجع إلى EventEmitter، بحيث يمكن ربط الاستدعاءات.

بشكل افتراضي، يتم استدعاء مستمعي الأحداث بالترتيب الذي تتم إضافتهم به. emitter.prependListener() يمكن استخدام الأسلوب كبديل لإضافة مستمع الحدث إلى بداية صفيف المستمعين.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

function on<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

المعلمات

eventName

string | symbol

اسم الحدث.

listener

(args: any[]) => void

دالة رد الاتصال

المرتجعات

Twin

موروث من EventEmitter.on

once(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterOptions)

Promise ينشئ الذي يتم تنفيذه عند EventEmitter إصدار الحدث المحدد أو الذي يتم رفضه إذا EventEmitter تم إصداره 'error' أثناء الانتظار. Promise سيتم حل مع صفيف من جميع الوسيطات المنبعثة إلى الحدث المحدد.

هذه الطريقة عامة عمدا وتعمل مع واجهة EventTarget للنظام الأساسي على الويب، والتي لا تحتوي على دلالات حدث خاص'error' ولا تستمع إلى 'error' الحدث.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

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.error('error happened', err);
}

يتم استخدام المعالجة الخاصة للحدث 'error' فقط عند events.once() استخدامها لانتظار حدث آخر. إذا events.once() تم استخدام لانتظار الحدث نفسهerror' ، فسيتم التعامل معه كأي نوع آخر من الأحداث دون معالجة خاصة:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.error('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

AbortSignal يمكن استخدام لإلغاء انتظار الحدث:

import { EventEmitter, once } from 'node: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!

static function once(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>

المعلمات

emitter

EventEmitter<DefaultEventMap>

eventName

string | symbol

options

StaticEventEmitterOptions

المرتجعات

Promise<any[]>

موروث من EventEmitter.once

once(EventTarget, string, StaticEventEmitterOptions) 

static function once(emitter: EventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>

المعلمات

emitter

EventTarget

eventName

string

options

StaticEventEmitterOptions

المرتجعات

Promise<any[]>

موروث من EventEmitter.once

once<K>(string | symbol, (args: any[]) => void)

يضيف دالة لمرةlistener واحدة للحدث المسمى eventName. في المرة eventName التالية التي يتم فيها تشغيل، تتم إزالة وحدة الاستماع هذه ثم استدعاؤها.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

إرجاع مرجع إلى EventEmitter، بحيث يمكن ربط الاستدعاءات.

بشكل افتراضي، يتم استدعاء مستمعي الأحداث بالترتيب الذي تتم إضافتهم به. emitter.prependOnceListener() يمكن استخدام الأسلوب كبديل لإضافة مستمع الحدث إلى بداية صفيف المستمعين.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

function once<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

المعلمات

eventName

string | symbol

اسم الحدث.

listener

(args: any[]) => void

دالة رد الاتصال

المرتجعات

Twin

موروث من EventEmitter.once

prependListener<K>(string | symbol, (args: any[]) => void)

يضيف الدالة listener إلى بداية صفيف المستمعين للحدث المسمى eventName. لا يتم إجراء أي عمليات فحص لمعرفة ما إذا كان listener قد تمت إضافته بالفعل. ستؤدي المكالمات المتعددة التي تمرر نفس المجموعة من eventName و listener إلى listener إضافة واستدعاء عدة مرات.

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

إرجاع مرجع إلى EventEmitter، بحيث يمكن ربط الاستدعاءات.

function prependListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

المعلمات

eventName

string | symbol

اسم الحدث.

listener

(args: any[]) => void

دالة رد الاتصال

المرتجعات

Twin

موروث من EventEmitter.prependListener

prependOnceListener<K>(string | symbol, (args: any[]) => void)

يضيف دالة لمرةlistener واحدة للحدث المسمى eventName إلى بداية صفيف المستمعين. في المرة eventName التالية التي يتم فيها تشغيل، تتم إزالة وحدة الاستماع هذه، ثم استدعاؤها.

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

إرجاع مرجع إلى EventEmitter، بحيث يمكن ربط الاستدعاءات.

function prependOnceListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

المعلمات

eventName

string | symbol

اسم الحدث.

listener

(args: any[]) => void

دالة رد الاتصال

المرتجعات

Twin

موروث من EventEmitter.prependOnceListener

rawListeners<K>(string | symbol)

إرجاع نسخة من صفيف المستمعين للحدث المسمى eventName، بما في ذلك أي برامج تضمين (مثل تلك التي تم إنشاؤها بواسطة .once()).

import { EventEmitter } from 'node:events';
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');

function rawListeners<K>(eventName: string | symbol): Function[]

المعلمات

eventName

string | symbol

المرتجعات

Function[]

موروث من EventEmitter.rawListeners

removeAllListeners(string | symbol)

يزيل جميع المستمعين أو المستمعين المحددين eventName.

من الممارسات السيئة إزالة المستمعين الذين تمت إضافتهم في مكان آخر في التعليمات البرمجية، خاصة عندما EventEmitter تم إنشاء المثيل بواسطة بعض المكونات أو الوحدة النمطية الأخرى (مثل مآخذ التوصيل أو تدفقات الملفات).

إرجاع مرجع إلى EventEmitter، بحيث يمكن ربط الاستدعاءات.

function removeAllListeners(eventName?: string | symbol): Twin

المعلمات

eventName

string | symbol

المرتجعات

Twin

موروث من EventEmitter.removeAllListeners

removeListener<K>(string | symbol, (args: any[]) => void)

يزيل المحدد listener من صفيف وحدة الاستماع للحدث المسمى eventName.

const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() سيزيل، على الأكثر، مثيلا واحدا من وحدة الاستماع من صفيف المستمع. إذا تمت إضافة أي وحدة استماع واحدة عدة مرات إلى صفيف المستمع للمحدد eventName، removeListener() فيجب استدعاء عدة مرات لإزالة كل مثيل.

بمجرد إصدار حدث، يتم استدعاء جميع المستمعين المرفقين به في وقت الانبعاث بالترتيب. وهذا يعني أن أي removeListener() أو removeAllListeners()استدعاءات بعد الانبعاث وقبل انتهاء المستمع الأخير من التنفيذ لن يزيلها منemit() قيد التقدم. تتصرف الأحداث اللاحقة كما هو متوقع.

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
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') الاستماع:

import { EventEmitter } from 'node:events';
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، بحيث يمكن ربط الاستدعاءات.

function removeListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Twin

المعلمات

eventName

string | symbol

listener

(args: any[]) => void

المرتجعات

Twin

موروث من EventEmitter.removeListener

setMaxListeners(number)

بشكل افتراضي EventEmitter، سيطبع s تحذيرا إذا تمت إضافة أكثر من 10 وحدات الاستماع لحدث معين. هذا افتراضي مفيد يساعد على العثور على تسربات الذاكرة. emitter.setMaxListeners() يسمح الأسلوب بتعديل الحد لهذا المثيل المحددEventEmitter. يمكن تعيين القيمة إلى Infinity (أو 0) للإشارة إلى عدد غير محدود من المستمعين.

إرجاع مرجع إلى EventEmitter، بحيث يمكن ربط الاستدعاءات.

function setMaxListeners(n: number): Twin

المعلمات

n

number

المرتجعات

Twin

موروث من EventEmitter.setMaxListeners

setMaxListeners(number, (EventEmitter<DefaultEventMap> | EventTarget)[]) 

import { setMaxListeners, EventEmitter } from 'node:events';

const target = new EventTarget();
const emitter = new EventEmitter();

setMaxListeners(5, target, emitter);

static function setMaxListeners(n?: number, eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[])

المعلمات

n

number

رقم غير سالب. الحد الأقصى لعدد المستمعين لكل EventTarget حدث.

eventTargets

(EventEmitter<DefaultEventMap> | EventTarget)[]

موروث من EventEmitter.setMaxListeners

[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest) 

function [captureRejectionSymbol]<K>(error: Error, event: string | symbol, args: AnyRest)

المعلمات

error

Error

event

string | symbol

args

AnyRest

موروث من EventEmitter.__@captureRejectionSymbol@138