Client class
يتم استخدام عميل خدمة IoT Hub للاتصال بالأجهزة من خلال مركز Azure IoT. يتيح لمستخدم SDK:
- إرسال السحابة إلى الجهاز (المعروفة أيضا بالأوامر) إلى الأجهزة: يتم وضع الأوامر في قائمة الانتظار على IoT Hub ويتم تسليمها بشكل غير متزامن فقط عند توصيل الجهاز. يمكن وضع 50 أمر فقط في قائمة الانتظار لكل جهاز.
- استدعاء أساليب مباشرة على الأجهزة (والتي ستعمل فقط إذا كان الجهاز متصلا حاليا: إنها طريقة متزامنة للتواصل مع الجهاز)
- استمع إلى رسائل الملاحظات المرسلة بواسطة الأجهزة للأوامر السابقة.
- استمع إلى إعلامات تحميل الملفات من الأجهزة.
يجب على المستخدمين إنشاء مثيلات Client جديدة عن طريق استدعاء أحد أساليب المصنع، منConnectionString أو منSharedAccessSignature، لإنشاء عميل خدمة IoT Hub.
- يمتد
-
EventEmitter
الخصائص الموروثة
capture |
القيمة: المنطقية تغيير خيار |
capture |
القيمة: راجع كيفية كتابة |
default |
بشكل افتراضي، يمكن تسجيل وحدة استماع كن حذرا عند تعيين هذا ليس حدا صعبا. سيسمح مثيل
يمكن استخدام علامة سطر الأوامر يمكن فحص التحذير المنبعث باستخدام |
error |
يجب استخدام هذا الرمز لتثبيت وحدة استماع لمراقبة الأحداث لا يؤدي تثبيت وحدة استماع باستخدام هذا الرمز إلى تغيير السلوك بمجرد إصدار حدث |
الأساليب
الأساليب المتوارثة
add |
يستمع مرة واحدة إلى الحدث الاستماع إلى الحدث تسمح واجهة برمجة التطبيقات هذه بأمان باستخدام إرجاع يمكن التخلص منه بحيث يمكن إلغاء اشتراكه من بسهولة أكبر.
|
add |
الاسم المستعار ل |
emit<K>(string | symbol, Any |
يستدعي بشكل متزامن كل من المستمعين المسجلين للحدث المسمى إرجاع
|
event |
إرجاع صفيف يسرد الأحداث التي قام المرسل بتسجيل المستمعين لها. القيم في الصفيف هي سلاسل أو
|
get |
إرجاع نسخة من صفيف المستمعين للحدث المسمى على سبيل على سبيل
|
get |
إرجاع قيمة وحدة الإصغاء القصوى الحالية |
get |
إرجاع الحد الأقصى المعين حاليا للمستمعين. على سبيل على سبيل
|
listener |
أسلوب فئة يرجع عدد المستمعين
|
listener |
إرجاع عدد المستمعين المستمعين للحدث المسمى |
listeners<K>(string | symbol) | إرجاع نسخة من صفيف المستمعين للحدث المسمى
|
off<K>(string | symbol, (args: any[]) => void) | الاسم المستعار ل |
on(Event |
إرجاع يمكن استخدام
استخدم الخيار
|
on(Event |
|
on<K>(string | symbol, (args: any[]) => void) | يضيف الدالة
إرجاع مرجع إلى بشكل افتراضي، يتم استدعاء مستمعي الأحداث بالترتيب الذي تتم إضافتهم به. يمكن استخدام أسلوب
|
once(Event |
إنشاء هذه الطريقة عامة عمدا وتعمل مع النظام الأساسي للويب واجهة EventTarget، والتي لا تحتوي على دلالات أحداث
يتم استخدام المعالجة الخاصة للحدث
يمكن استخدام
|
once(Event |
|
once<K>(string | symbol, (args: any[]) => void) | إضافة دالة
إرجاع مرجع إلى بشكل افتراضي، يتم استدعاء مستمعي الأحداث بالترتيب الذي تتم إضافتهم به. يمكن استخدام أسلوب
|
prepend |
إضافة الدالة
إرجاع مرجع إلى |
prepend |
إضافة دالة
إرجاع مرجع إلى |
raw |
إرجاع نسخة من صفيف المستمعين للحدث المسمى
|
remove |
إزالة كافة وحدات الاستماع، أو تلك الخاصة من الممارسات السيئة إزالة المستمعين الذين تمت إضافتهم في مكان آخر في التعليمات البرمجية، خاصة عند إنشاء مثيل إرجاع مرجع إلى |
remove |
يزيل
سيقوم بمجرد إصدار حدث، يتم استدعاء جميع المستمعين المرفقين به في وقت الانبعاث بالترتيب. وهذا يعني أن أي مكالمات
نظرا لأنه تتم إدارة المستمعين باستخدام صفيف داخلي، سيؤدي استدعاء هذا إلى تغيير فهارس موضع أي وحدة استماع مسجلة بعد إزالة وحدة الاستماع. لن يؤثر هذا على الترتيب الذي يتم استدعاء المستمعين به، ولكنه يعني أن أي نسخ من صفيف وحدة الاستماع كما تم إرجاعها بواسطة أسلوب عند إضافة دالة واحدة كمعالج عدة مرات لحدث واحد (كما في المثال أدناه)، سيقوم
إرجاع مرجع إلى |
set |
بشكل افتراضي، ستقوم إرجاع مرجع إلى |
set |
|
[capture |
تفاصيل الخاصية الموروثة
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')
وسيكون له خصائص emitter
type
count
الإضافية، مع الإشارة إلى مثيل انبعاث الحدث واسم الحدث وعدد المستمعين المرفقين، على التوالي.
تم تعيين الخاصية name
الخاصة به إلى 'MaxListenersExceededWarning'
.
static defaultMaxListeners: number
قيمة الخاصية
number
موروث من EventEmitter.defaultMaxListeners
errorMonitor
يجب استخدام هذا الرمز لتثبيت وحدة استماع لمراقبة الأحداث 'error'
فقط. يتم استدعاء وحدات الاستماع المثبتة باستخدام هذا الرمز قبل استدعاء وحدات الاستماع 'error'
العادية.
لا يؤدي تثبيت وحدة استماع باستخدام هذا الرمز إلى تغيير السلوك بمجرد إصدار حدث 'error'
. لذلك، ستستمر العملية في التعطل إذا لم يتم تثبيت وحدة استماع 'error'
عادية.
static errorMonitor: typeof errorMonitor
قيمة الخاصية
typeof errorMonitor
موروث من EventEmitter.errorMonitor
تفاصيل الأسلوب
close()
function close(): Promise<ResultWithIncomingMessage<Disconnected>>
المرتجعات
Promise<ResultWithIncomingMessage<Disconnected>>
close(IncomingMessageCallback<Disconnected>)
إغلاق الاتصال بمركز IoT.
function close(done?: IncomingMessageCallback<Disconnected>)
المعلمات
- done
-
IncomingMessageCallback<Disconnected>
الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم تمرير done
وسيطة كائن خطأ، والتي ستكون فارغة إذا اكتملت العملية بنجاح.
fromConnectionString(string, TransportCtor)
إنشاء عميل خدمة IoT Hub من سلسلة الاتصال المحددة باستخدام النقل الافتراضي (Amqp) أو الذي تم تحديده في الوسيطة الثانية.
static function fromConnectionString(connStr: string, transportCtor?: TransportCtor): Client
المعلمات
- connStr
-
string
سلسلة اتصال تغلف أذونات "اتصال الجهاز" على مركز IoT.
- transportCtor
- TransportCtor
المرتجعات
fromSharedAccessSignature(string, TransportCtor)
إنشاء عميل خدمة IoT Hub من توقيع الوصول المشترك المحدد باستخدام النقل الافتراضي (Amqp) أو الذي تم تحديده في الوسيطة الثانية.
static function fromSharedAccessSignature(sharedAccessSignature: string, transportCtor?: TransportCtor): Client
المعلمات
- sharedAccessSignature
-
string
توقيع وصول مشترك يغلف أذونات "اتصال الخدمة" على مركز IoT.
- transportCtor
- TransportCtor
المرتجعات
fromTokenCredential(string, TokenCredential, TransportCtor)
إنشاء عميل خدمة IoT Hub من Azure tokenCredential المحدد باستخدام النقل الافتراضي (Amqp) أو الذي تم تحديده في الوسيطة الثانية.
static function fromTokenCredential(hostName: string, tokenCredential: TokenCredential, transportCtor?: TransportCtor): Client
المعلمات
- hostName
-
string
اسم المضيف لخدمة Azure.
- tokenCredential
- TokenCredential
Azure TokenCredential يستخدم للمصادقة مع خدمة Azure
- transportCtor
- TransportCtor
المرتجعات
getFeedbackReceiver()
function getFeedbackReceiver(): Promise<ResultWithIncomingMessage<ServiceReceiver>>
المرتجعات
Promise<ResultWithIncomingMessage<ServiceReceiver>>
getFeedbackReceiver(IncomingMessageCallback<ServiceReceiver>)
إرجاع كائن AmqpReceiver الذي يصدر الأحداث عند تلقي العميل رسائل ملاحظات جديدة.
function getFeedbackReceiver(done?: IncomingMessageCallback<ServiceReceiver>)
المعلمات
- done
-
IncomingMessageCallback<ServiceReceiver>
الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done
باستخدام وسيطتين: كائن خطأ (يمكن أن يكون خاليا) وعنصر AmqpReceiver.
getFileNotificationReceiver()
function getFileNotificationReceiver(): Promise<ResultWithIncomingMessage<ServiceReceiver>>
المرتجعات
Promise<ResultWithIncomingMessage<ServiceReceiver>>
getFileNotificationReceiver(IncomingMessageCallback<ServiceReceiver>)
إرجاع كائن AmqpReceiver الذي يصدر الأحداث عند تلقي العميل إعلامات تحميل ملف جديدة.
function getFileNotificationReceiver(done?: IncomingMessageCallback<ServiceReceiver>)
المعلمات
- done
-
IncomingMessageCallback<ServiceReceiver>
الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done
باستخدام وسيطتين: كائن خطأ (يمكن أن يكون خاليا) وعنصر AmqpReceiver.
invokeDeviceMethod(string, DeviceMethodParams)
function invokeDeviceMethod(deviceId: string, methodParams: DeviceMethodParams): Promise<ResultWithIncomingMessage<any>>
المعلمات
- deviceId
-
string
- methodParams
- DeviceMethodParams
المرتجعات
Promise<ResultWithIncomingMessage<any>>
invokeDeviceMethod(string, DeviceMethodParams, IncomingMessageCallback<any>)
استدعاء أسلوب على جهاز أو وحدة نمطية معينة.
function invokeDeviceMethod(deviceId: string, methodParams: DeviceMethodParams, done?: IncomingMessageCallback<any>)
المعلمات
- deviceId
-
string
معرف هوية جهاز موجودة.
- methodParams
- DeviceMethodParams
- done
-
IncomingMessageCallback<any>
رد الاتصال الاختياري للاتصال بنتيجة تنفيذ الأسلوب.
invokeDeviceMethod(string, string, DeviceMethodParams)
function invokeDeviceMethod(deviceId: string, moduleId: string, methodParams: DeviceMethodParams): Promise<ResultWithIncomingMessage<any>>
المعلمات
- deviceId
-
string
- moduleId
-
string
- methodParams
- DeviceMethodParams
المرتجعات
Promise<ResultWithIncomingMessage<any>>
invokeDeviceMethod(string, string, DeviceMethodParams, IncomingMessageCallback<any>)
function invokeDeviceMethod(deviceId: string, moduleId: string, methodParams: DeviceMethodParams, done: IncomingMessageCallback<any>)
المعلمات
- deviceId
-
string
- moduleId
-
string
- methodParams
- DeviceMethodParams
- done
-
IncomingMessageCallback<any>
open()
function open(): Promise<ResultWithIncomingMessage<Connected>>
المرتجعات
Promise<ResultWithIncomingMessage<Connected>>
open(IncomingMessageCallback<Connected>)
فتح الاتصال بمركز IoT.
function open(done?: IncomingMessageCallback<Connected>)
المعلمات
- done
-
IncomingMessageCallback<Connected>
الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم تمرير done
وسيطة كائن خطأ، والتي ستكون فارغة إذا اكتملت العملية بنجاح.
send(string, Message | BufferConvertible)
function send(deviceId: string, message: Message | BufferConvertible): Promise<ResultWithIncomingMessage<MessageEnqueued>>
المعلمات
- deviceId
-
string
- message
-
Message | BufferConvertible
المرتجعات
Promise<ResultWithIncomingMessage<MessageEnqueued>>
send(string, Message | BufferConvertible, IncomingMessageCallback<MessageEnqueued>)
إرسال رسالة إلى جهاز.
function send(deviceId: string, message: Message | BufferConvertible, done?: IncomingMessageCallback<MessageEnqueued>)
المعلمات
- deviceId
-
string
معرف هوية جهاز موجودة.
- message
-
Message | BufferConvertible
نص الرسالة لإرسالها إلى الجهاز.
إذا لم يكن message
من النوع Message، تحويله.
- done
-
IncomingMessageCallback<MessageEnqueued>
الدالة الاختيارية لاستدعاء عند اكتمال العملية. سيتم استدعاء done
باستخدام وسيطتين: كائن خطأ (يمكن أن يكون خاليا) وعنصر استجابة خاص بالنقل مفيد للتسجيل أو تصحيح الأخطاء.
setRetryPolicy(RetryPolicy)
تعيين النهج المستخدم من قبل العميل لإعادة محاولة عمليات الشبكة.
function setRetryPolicy(policy: RetryPolicy)
المعلمات
- policy
-
RetryPolicy
النهج المستخدم لإعادة محاولة العمليات (على سبيل المثال، فتح وإرسال وما إلى ذلك). تأتي SDK مع نهجين "مضمنين": ExponentialBackoffWithJitter (افتراضي) و NoRetry (لإلغاء أي شكل من أشكال إعادة المحاولة). يمكن للمستخدم أيضا تمرير الكائن الخاص به طالما أنه ينفذ طريقتين: - shouldRetry(err: Error): منطقي: يشير إلى ما إذا كان يجب إعادة محاولة العملية استنادا إلى نوع الخطأ - nextRetryTimeout(retryCount: number, مقيد: منطقي: رقم : إرجاع الوقت للانتظار (بالمللي ثانية) قبل إعادة المحاولة استنادا إلى العدد السابق من المحاولات (إعادة المحاولةCount) وحقيقة أن الخطأ هو خطأ تقييد أم لا.
تفاصيل الأساليب المتوارثة
addAbortListener(AbortSignal, (event: Event) => void)
يستمع مرة واحدة إلى الحدث abort
على signal
المتوفرة .
الاستماع إلى الحدث abort
على إشارات إحباط غير آمن وقد يؤدي إلى تسرب الموارد حيث يمكن لجهة خارجية أخرى مع الإشارة الاتصال e.stopImmediatePropagation()
. للأسف لا يمكن Node.js تغيير هذا لأنه قد ينتهك معيار الويب. بالإضافة إلى ذلك، تجعل واجهة برمجة التطبيقات الأصلية من السهل نسيان إزالة المستمعين.
تسمح واجهة برمجة التطبيقات هذه بأمان باستخدام AbortSignal
s في واجهات برمجة التطبيقات 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): Client
المعلمات
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
المرتجعات
موروث من 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()
إرجاع صفيف يسرد الأحداث التي قام المرسل بتسجيل المستمعين لها. القيم في الصفيف هي سلاسل أو Symbol
s.
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
s يتصرف هذا تماما مثل استدعاء .listeners
على الباعث.
على سبيل EventTarget
s هذه هي الطريقة الوحيدة للحصول على مستمعي الحدث لهدف الحدث. وهذا مفيد لأغراض تصحيح الأخطاء والتشخيص.
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)
أو الإعدادات الافتراضية إلى <xref:EventEmitter.defaultMaxListeners>.
function getMaxListeners(): number
المرتجعات
number
الموروثة من EventEmitter.getMaxListeners
getMaxListeners(EventEmitter<DefaultEventMap> | EventTarget)
إرجاع الحد الأقصى المعين حاليا للمستمعين.
على سبيل EventEmitter
s يتصرف هذا تماما مثل استدعاء .getMaxListeners
على الباعث.
على سبيل EventTarget
s هذه هي الطريقة الوحيدة للحصول على الحد الأقصى لمستمعي الحدث لهدف الحدث. إذا تجاوز عدد معالجات الأحداث على 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): Client
المعلمات
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
المرتجعات
موروث من EventEmitter.off
on(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterIteratorOptions)
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());
استخدم الخيار close
لتحديد صفيف من أسماء الأحداث التي ستنهي التكرار:
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);
ee.emit('close');
});
for await (const event of on(ee, 'foo', { close: ['close'] })) {
console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'
static function on(emitter: EventEmitter<DefaultEventMap>, eventName: string | symbol, options?: StaticEventEmitterIteratorOptions): AsyncIterator<any[], any, any>
المعلمات
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string | symbol
- options
-
StaticEventEmitterIteratorOptions
المرتجعات
AsyncIterator<any[], any, any>
AsyncIterator
التي تتكرر eventName
الأحداث المنبعثة من emitter
موروث من EventEmitter.on
on(EventTarget, string, StaticEventEmitterIteratorOptions)
static function on(emitter: EventTarget, eventName: string, options?: StaticEventEmitterIteratorOptions): AsyncIterator<any[], any, any>
المعلمات
- emitter
-
EventTarget
- eventName
-
string
- options
-
StaticEventEmitterIteratorOptions
المرتجعات
AsyncIterator<any[], any, any>
موروث من 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): Client
المعلمات
- eventName
-
string | symbol
اسم الحدث.
- listener
-
(args: any[]) => void
دالة رد الاتصال
المرتجعات
موروث من 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)
إضافة دالة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): Client
المعلمات
- eventName
-
string | symbol
اسم الحدث.
- listener
-
(args: any[]) => void
دالة رد الاتصال
المرتجعات
موروث من EventEmitter.once
prependListener<K>(string | symbol, (args: any[]) => void)
إضافة الدالة listener
بالفعل. ستؤدي المكالمات المتعددة التي تمر بنفس المجموعة من eventName
listener
إلى إضافة listener
واستدعاؤها عدة مرات.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
إرجاع مرجع إلى EventEmitter
، بحيث يمكن ربط الاستدعاءات.
function prependListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
المعلمات
- eventName
-
string | symbol
اسم الحدث.
- listener
-
(args: any[]) => void
دالة رد الاتصال
المرتجعات
موروث من EventEmitter.prependListener
prependOnceListener<K>(string | symbol, (args: any[]) => void)
إضافة دالةeventName
، تتم إزالة وحدة الاستماع هذه، ثم استدعاؤها.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
إرجاع مرجع إلى EventEmitter
، بحيث يمكن ربط الاستدعاءات.
function prependOnceListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
المعلمات
- eventName
-
string | symbol
اسم الحدث.
- listener
-
(args: any[]) => void
دالة رد الاتصال
المرتجعات
موروث من 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): Client
المعلمات
- eventName
-
string | symbol
المرتجعات
موروث من 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): Client
المعلمات
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
المرتجعات
موروث من EventEmitter.removeListener
setMaxListeners(number)
بشكل افتراضي، ستقوم EventEmitter
s بطباعة تحذير إذا تمت إضافة أكثر من 10
وحدة استماع لحدث معين. هذا افتراضي مفيد يساعد في العثور على تسرب الذاكرة. يسمح الأسلوب emitter.setMaxListeners()
بتعديل الحد لهذا المثيل EventEmitter
المحدد. يمكن تعيين القيمة إلى Infinity
(أو 0
) للإشارة إلى عدد غير محدود من المستمعين.
إرجاع مرجع إلى EventEmitter
، بحيث يمكن ربط الاستدعاءات.
function setMaxListeners(n: number): Client
المعلمات
- n
-
number
المرتجعات
موروث من 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)[]
صفر أو أكثر من مثيلات {EventTarget} أو {EventEmitter}. إذا لم يتم تحديد أي عنصر، يتم تعيين n
كحد أقصى افتراضي لكافة كائنات {EventTarget} و{EventEmitter} التي تم إنشاؤها حديثا.
موروث من 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@118