ModuleClient class

‏‏المرجع

الحزمة:: azure-iot-device

يستخدم عميل جهاز IoT Hub لتوصيل جهاز بمركز Azure IoT.

يجب على مستخدمي SDK استدعاء أحد أساليب المصنع، منConnectionString أو منSharedAccessSignature لإنشاء عميل جهاز IoT Hub.

يمتد: InternalClient

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

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')` وسيكون له خصائص `emittertypecount` الإضافية، مع الإشارة إلى مثيل انبعاث الحدث واسم الحدث وعدد المستمعين المرفقين، على التوالي. تم تعيين الخاصية `name` الخاصة به إلى `'MaxListenersExceededWarning'`.
errorMonitor	يجب استخدام هذا الرمز لتثبيت وحدة استماع لمراقبة الأحداث `'error'` فقط. يتم استدعاء وحدات الاستماع المثبتة باستخدام هذا الرمز قبل استدعاء وحدات الاستماع `'error'` العادية. لا يؤدي تثبيت وحدة استماع باستخدام هذا الرمز إلى تغيير السلوك بمجرد إصدار حدث `'error'`. لذلك، ستستمر العملية في التعطل إذا لم يتم تثبيت وحدة استماع `'error'` عادية.

الأساليب

close()
close(Callback<Disconnected>)	إغلاق اتصال النقل وإتلاف موارد العميل. ملاحظة: بعد استدعاء هذا الأسلوب، لا يمكن إعادة استخدام كائن ModuleClient.
fromAuthenticationProvider(AuthenticationProvider, any)	إنشاء عميل وحدة IoT Hub من أسلوب المصادقة المحدد واستخدام نوع النقل المحدد.
fromConnectionString(string, any)	إنشاء عميل جهاز IoT Hub من سلسلة الاتصال المحددة باستخدام نوع النقل المحدد.
fromEnvironment(any)
fromEnvironment(any, Callback<ModuleClient>)	إنشاء عميل وحدة IoT Hub باستخدام معلومات التكوين من البيئة. إذا كان هناك متغير بيئة يسمى `EdgeHubConnectionString` أو `IotHubConnectionString` موجودا، استخدام هذه القيمة والسلوك مطابق لاستدعاء `fromConnectionString` تمرير ذلك. إذا لم تكن متغيرات البيئة هذه موجودة، فيجب تعريف المتغيرات التالية: `- IOTEDGE_WORKLOADURI URI for iotedged's workload API - IOTEDGE_DEVICEID Device identifier - IOTEDGE_MODULEID Module identifier - IOTEDGE_MODULEGENERATIONID Module generation identifier - IOTEDGE_IOTHUBHOSTNAME IoT Hub host name - IOTEDGE_AUTHSCHEME Authentication scheme to use; must be "sasToken"`
fromSharedAccessSignature(string, any)	إنشاء عميل وحدة IoT Hub من توقيع الوصول المشترك المحدد باستخدام نوع النقل المحدد.
invokeMethod(string, MethodParams)
invokeMethod(string, MethodParams, Callback<MethodResult>)	استدعاء أسلوب على جهاز انتقال البيانات من الخادم أو على وحدة نمطية أخرى على نفس جهاز IoTEdge. يرجى ملاحظة أن هذه الميزة تعمل فقط عند تشغيل الوحدة النمطية كجزء من جهاز IoTEdge.
invokeMethod(string, string, MethodParams)
invokeMethod(string, string, MethodParams, Callback<MethodResult>)
onMethod(string, DoubleValueCallback<DeviceMethodRequest, DeviceMethodResponse>)	تسجيل رد اتصال لأسلوب يسمى `methodName`.
sendOutputEvent(string, Message)
sendOutputEvent(string, Message, Callback<MessageEnqueued>)	إرسال حدث إلى إخراج الوحدة النمطية المحددة
sendOutputEventBatch(string, Message[])
sendOutputEventBatch(string, Message[], Callback<MessageEnqueued>)	إرسال صفيف من الأحداث إلى إخراج الوحدة النمطية المحددة
setOptions(DeviceClientOptions)
setOptions(DeviceClientOptions, Callback<TransportConfigured>)	تمرير الخيارات إلى كائن `ModuleClient` الذي يمكن استخدامه لتكوين النقل.

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

abandon(Message)
abandon(Message, Callback<MessageAbandoned>)
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](); } }`
addListener<EventName>(EventName, Listener<{}, EventName>)	الاسم المستعار ل `emitter.on(eventName, listener)`.
addListener<EventName>(EventName, Listener<{}, EventName>)
complete(Message)
complete(Message, Callback<MessageCompleted>)
emit<EventName>(EventName, Args<{}, EventName>)	يستدعي بشكل متزامن كل من المستمعين المسجلين للحدث المسمى `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
emit<EventName>(EventName, Args<{}, EventName>)
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) ]`
getEventListeners(EventEmitter<{}> \| EventTarget, string \| symbol)
getEventListeners<Events, EventName>(EventEmitter<Events>, EventName)	إرجاع نسخة من صفيف المستمعين للحدث المسمى `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] ] }`
getMaxListeners()	إرجاع قيمة وحدة الاستماع القصوى الحالية `EventEmitter` التي تم تعيينها إما بواسطة `emitter.setMaxListeners(n)` أو الإعدادات الافتراضية إلى defaultMaxListeners.
getMaxListeners(EventEmitter<{}> \| 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 }`
getTwin()
getTwin(Callback<Twin>)
listenerCount(EventEmitter<{}>, 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<EventName>(EventName, Listener<{}, EventName>)	إرجاع عدد المستمعين المستمعين للحدث المسمى `eventName`. إذا تم توفير `listener`، فسيرجع عدد المرات التي يتم فيها العثور على وحدة الاستماع في قائمة وحدات الاستماع للحدث.
listenerCount<EventName>(EventName, Listener<{}, EventName>)
listenerCount<Events, EventName>(EventEmitter<Events>, EventName)	أسلوب فئة يرجع عدد المستمعين `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`
listeners<EventName>(EventName)	إرجاع نسخة من صفيف المستمعين للحدث المسمى `eventName`. `server.on('connection', (stream) => { console.log('someone connected!'); }); console.log(util.inspect(server.listeners('connection'))); // Prints: [ [Function] ]`
listeners<EventName>(EventName)
off<EventName>(EventName, Listener<{}, EventName>)	الاسم المستعار ل `emitter.removeListener()`.
off<EventName>(EventName, Listener<{}, EventName>)
on(EventEmitter<{}>, string \| symbol, StaticEventEmitterIteratorOptions)
on(EventTarget, string, StaticEventEmitterIteratorOptions)
on<EventName>(EventName, Listener<{}, EventName>)	يضيف الدالة `listener` إلى نهاية صفيف المستمعين للحدث المسمى `eventName`. لا يتم إجراء أي فحوصات لمعرفة ما إذا كان قد تمت إضافة `listener` بالفعل. ستؤدي المكالمات المتعددة التي تمر بنفس المجموعة من `eventNamelistener` إلى إضافة `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`
on<EventName>(EventName, Listener<{}, EventName>)
on<Events, EventName>(EventEmitter<Events>, EventName, 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'`
once(EventEmitter<{}>, string \| symbol, StaticEventEmitterOptions)
once(EventTarget, string, StaticEventEmitterOptions)
once<EventName>(EventName, 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`
once<EventName>(EventName, Listener<{}, EventName>)
once<Events, EventName>(EventEmitter<Events>, EventName, 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!
open()
open(Callback<Connected>)
prependListener<EventName>(EventName, Listener<{}, EventName>)	إضافة الدالة إلى بداية من صفيف المستمعين للحدث المسمى . لا يتم إجراء أي فحوصات لمعرفة ما إذا كان قد تمت إضافة `listener` بالفعل. ستؤدي المكالمات المتعددة التي تمر بنفس المجموعة من `eventNamelistener` إلى إضافة `listener` واستدعاؤها عدة مرات. `server.prependListener('connection', (stream) => { console.log('someone connected!'); });` إرجاع مرجع إلى `EventEmitter`، بحيث يمكن ربط الاستدعاءات.
prependListener<EventName>(EventName, Listener<{}, EventName>)
prependOnceListener<EventName>(EventName, Listener<{}, EventName>)	إضافة دالة لمرة واحدة للحدث المسمى إلى بداية من صفيف المستمعين. في المرة التالية التي يتم فيها تشغيل `eventName`، تتم إزالة وحدة الاستماع هذه، ثم استدعاؤها. `server.prependOnceListener('connection', (stream) => { console.log('Ah, we have our first user!'); });` إرجاع مرجع إلى `EventEmitter`، بحيث يمكن ربط الاستدعاءات.
prependOnceListener<EventName>(EventName, Listener<{}, EventName>)
rawListeners<EventName>(EventName)	إرجاع نسخة من صفيف المستمعين للحدث المسمى `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');
rawListeners<EventName>(EventName)
reject(Message)
reject(Message, Callback<MessageRejected>)
removeAllListeners<EventName>(EventName)	إزالة كافة وحدات الاستماع، أو تلك الخاصة `eventName`المحددة. من الممارسات السيئة إزالة المستمعين الذين تمت إضافتهم في مكان آخر في التعليمات البرمجية، خاصة عند إنشاء مثيل `EventEmitter` بواسطة مكون أو وحدة أخرى (مثل مآخذ التوصيل أو تدفقات الملفات). إرجاع مرجع إلى `EventEmitter`، بحيث يمكن ربط الاستدعاءات.
removeAllListeners<EventName>(EventName)
removeListener<EventName>(EventName, Listener<{}, EventName>)	يزيل `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`، بحيث يمكن ربط الاستدعاءات.
removeListener<EventName>(EventName, Listener<{}, EventName>)
sendEvent(Message)
sendEvent(Message, Callback<MessageEnqueued>)
sendEventBatch(Message[])
sendEventBatch(Message[], Callback<MessageEnqueued>)
setMaxListeners(number)	بشكل افتراضي، ستقوم `EventEmitter`s بطباعة تحذير إذا تمت إضافة أكثر من `10` وحدة استماع لحدث معين. هذا افتراضي مفيد يساعد في العثور على تسرب الذاكرة. يسمح الأسلوب `emitter.setMaxListeners()` بتعديل الحد لهذا المثيل `EventEmitter` المحدد. يمكن تعيين القيمة إلى `Infinity` (أو `0`) للإشارة إلى عدد غير محدود من المستمعين. إرجاع مرجع إلى `EventEmitter`، بحيث يمكن ربط الاستدعاءات.
setMaxListeners(number, (EventEmitter<{}> \| EventTarget)[])	`import { setMaxListeners, EventEmitter } from 'node:events'; const target = new EventTarget(); const emitter = new EventEmitter(); setMaxListeners(5, target, emitter);`
setRetryPolicy(RetryPolicy)	تعيين نهج إعادة المحاولة المستخدم من قبل العميل على جميع العمليات. الإعداد الافتراضي هو ExponentialBackoffWithJitter.
setTransportOptions(any)
setTransportOptions(any, Callback<TransportConfigured>)
updateSharedAccessSignature(string, Callback<SharedAccessSignatureUpdated>)
[captureRejectionSymbol](Error, string \| symbol, any[])
[captureRejectionSymbol]<EventName>(Error, EventName, Args<{}, EventName>)

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

captureRejections

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

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

static captureRejections: boolean

قيمة الخاصية

boolean

موروث من InternalClient.captureRejections

captureRejectionSymbol

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

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

static captureRejectionSymbol: typeof captureRejectionSymbol

قيمة الخاصية

typeof captureRejectionSymbol

موروث من InternalClient.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') وسيكون له خصائص emittertypecount الإضافية، مع الإشارة إلى مثيل انبعاث الحدث واسم الحدث وعدد المستمعين المرفقين، على التوالي. تم تعيين الخاصية name الخاصة به إلى 'MaxListenersExceededWarning'.

static defaultMaxListeners: number

قيمة الخاصية

number

موروث من InternalClient.defaultMaxListeners

errorMonitor

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

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

static errorMonitor: typeof errorMonitor

قيمة الخاصية

typeof errorMonitor

موروث من InternalClient.errorMonitor

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

close()

function close(): Promise<Disconnected>

المرتجعات

Promise<Disconnected>

close(Callback<Disconnected>)

إغلاق اتصال النقل وإتلاف موارد العميل.

ملاحظة: بعد استدعاء هذا الأسلوب، لا يمكن إعادة استخدام كائن ModuleClient.

function close(closeCallback?: Callback<Disconnected>)

المعلمات

closeCallback: Callback<Disconnected>

دالة اختيارية لاستدعاء بمجرد قطع اتصال النقل وإغلاق العميل.

fromAuthenticationProvider(AuthenticationProvider, any)

إنشاء عميل وحدة IoT Hub من أسلوب المصادقة المحدد واستخدام نوع النقل المحدد.

static function fromAuthenticationProvider(authenticationProvider: AuthenticationProvider, transportCtor: any): ModuleClient

المعلمات

authenticationProvider: AuthenticationProvider

الكائن المستخدم للحصول على معلمات المصادقة لمركز IoT.

transportCtor: any

بروتوكول النقل المستخدم للاتصال بمركز IoT.

المرتجعات

ModuleClient

fromConnectionString(string, any)

إنشاء عميل جهاز IoT Hub من سلسلة الاتصال المحددة باستخدام نوع النقل المحدد.

static function fromConnectionString(connStr: string, transportCtor: any): ModuleClient

المعلمات

connStr: string

سلسلة اتصال تغلف أذونات "اتصال الجهاز" على مركز IoT.

transportCtor: any

منشئ النقل.

المرتجعات

ModuleClient

fromEnvironment(any)

static function fromEnvironment(transportCtor: any): Promise<ModuleClient>

المعلمات

transportCtor: any

المرتجعات

Promise<ModuleClient>

fromEnvironment(any, Callback<ModuleClient>)

إنشاء عميل وحدة IoT Hub باستخدام معلومات التكوين من البيئة.

إذا كان هناك متغير بيئة يسمى EdgeHubConnectionString أو IotHubConnectionString موجودا، استخدام هذه القيمة والسلوك مطابق لاستدعاء fromConnectionString تمرير ذلك. إذا لم تكن متغيرات البيئة هذه موجودة، فيجب تعريف المتغيرات التالية:

- IOTEDGE_WORKLOADURI          URI for iotedged's workload API
- IOTEDGE_DEVICEID             Device identifier
- IOTEDGE_MODULEID             Module identifier
- IOTEDGE_MODULEGENERATIONID   Module generation identifier
- IOTEDGE_IOTHUBHOSTNAME       IoT Hub host name
- IOTEDGE_AUTHSCHEME           Authentication scheme to use; must be "sasToken"

static function fromEnvironment(transportCtor: any, callback?: Callback<ModuleClient>)

المعلمات

transportCtor: any

بروتوكول النقل المستخدم للاتصال بمركز IoT.

callback: Callback<ModuleClient>

رد اتصال اختياري لاستدعاء عند إنشاء ModuleClient أو إذا حدث خطأ أثناء إنشاء العميل.

fromSharedAccessSignature(string, any)

إنشاء عميل وحدة IoT Hub من توقيع الوصول المشترك المحدد باستخدام نوع النقل المحدد.

static function fromSharedAccessSignature(sharedAccessSignature: string, transportCtor: any): ModuleClient

المعلمات

sharedAccessSignature: string

توقيع وصول مشترك يغلف أذونات "اتصال الجهاز" على مركز IoT.

transportCtor: any

المرتجعات

ModuleClient

invokeMethod(string, MethodParams)

function invokeMethod(deviceId: string, methodParams: MethodParams): Promise<MethodResult>

المعلمات

deviceId: string

methodParams: MethodParams

المرتجعات

Promise<MethodResult>

invokeMethod(string, MethodParams, Callback<MethodResult>)

استدعاء أسلوب على جهاز انتقال البيانات من الخادم أو على وحدة نمطية أخرى على نفس جهاز IoTEdge. يرجى ملاحظة أن هذه الميزة تعمل فقط عند تشغيل الوحدة النمطية كجزء من جهاز IoTEdge.

function invokeMethod(deviceId: string, methodParams: MethodParams, callback?: Callback<MethodResult>)

المعلمات

deviceId: string

معرف الجهاز الهدف

methodParams: MethodParams

معلمات استدعاء الأسلوب المباشر

callback: Callback<MethodResult>

رد الاتصال الاختياري الذي سيتم استدعاؤه إما باستخدام كائن خطأ أو نتيجة استدعاء الأسلوب.

invokeMethod(string, string, MethodParams)

function invokeMethod(deviceId: string, moduleId: string, methodParams: MethodParams): Promise<MethodResult>

المعلمات

deviceId: string

moduleId: string

methodParams: MethodParams

المرتجعات

Promise<MethodResult>

invokeMethod(string, string, MethodParams, Callback<MethodResult>)

function invokeMethod(deviceId: string, moduleId: string, methodParams: MethodParams, callback: Callback<MethodResult>)

المعلمات

deviceId: string

moduleId: string

methodParams: MethodParams

callback: Callback<MethodResult>

onMethod(string, DoubleValueCallback<DeviceMethodRequest, DeviceMethodResponse>)

تسجيل رد اتصال لأسلوب يسمى methodName.

function onMethod(methodName: string, callback: DoubleValueCallback<DeviceMethodRequest, DeviceMethodResponse>)

المعلمات

methodName: string

اسم الأسلوب الذي سيتم التعامل معه بواسطة رد الاتصال

callback: DoubleValueCallback<DeviceMethodRequest, DeviceMethodResponse>

الدالة التي يجب استدعاؤها كلما تم تلقي طلب أسلوب للأسلوب المسمى methodName.

sendOutputEvent(string, Message)

function sendOutputEvent(outputName: string, message: Message): Promise<MessageEnqueued>

المعلمات

outputName: string

message: Message

المرتجعات

Promise<MessageEnqueued>

sendOutputEvent(string, Message, Callback<MessageEnqueued>)

إرسال حدث إلى إخراج الوحدة النمطية المحددة

function sendOutputEvent(outputName: string, message: Message, callback?: Callback<MessageEnqueued>)

المعلمات

outputName: string

اسم الإخراج لإرسال الحدث إلى

message: Message

رسالة لإرسالها إلى الإخراج المحدد

callback: Callback<MessageEnqueued>

دالة اختيارية لاستدعاء عند وضع العملية في قائمة الانتظار.

sendOutputEventBatch(string, Message[])

function sendOutputEventBatch(outputName: string, messages: Message[]): Promise<MessageEnqueued>

المعلمات

outputName: string

messages: Message[]

المرتجعات

Promise<MessageEnqueued>

sendOutputEventBatch(string, Message[], Callback<MessageEnqueued>)

إرسال صفيف من الأحداث إلى إخراج الوحدة النمطية المحددة

function sendOutputEventBatch(outputName: string, messages: Message[], callback?: Callback<MessageEnqueued>)

المعلمات

outputName: string

اسم الإخراج لإرسال الأحداث إليه

messages: Message[]

callback: Callback<MessageEnqueued>

دالة لاستدعاء عند وضع العمليات في قائمة الانتظار.

setOptions(DeviceClientOptions)

function setOptions(options: DeviceClientOptions): Promise<TransportConfigured>

المعلمات

options: DeviceClientOptions

المرتجعات

Promise<TransportConfigured>

setOptions(DeviceClientOptions, Callback<TransportConfigured>)

تمرير الخيارات إلى كائن ModuleClient الذي يمكن استخدامه لتكوين النقل.

function setOptions(options: DeviceClientOptions, done?: Callback<TransportConfigured>)

المعلمات

options: DeviceClientOptions

كائن DeviceClientOptions.

done: Callback<TransportConfigured>

رد اتصال اختياري للاتصال بمجرد تعيين الخيارات.

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

abandon(Message)

function abandon(message: Message): Promise<MessageAbandoned>

المعلمات

message: Message

المرتجعات

Promise<MessageAbandoned>

موروث من InternalClient.abandon

abandon(Message, Callback<MessageAbandoned>)

function abandon(message: Message, abandonCallback: Callback<MessageAbandoned>)

المعلمات

message: Message

abandonCallback: Callback<MessageAbandoned>

موروث من InternalClient.abandon

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.

موروث من InternalClient.addAbortListener

addListener<EventName>(EventName, Listener<{}, EventName>)

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

function addListener<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

listener: Listener<{}, EventName>

المرتجعات

ModuleClient

موروث من InternalClient.addListener

addListener<EventName>(EventName, Listener<{}, EventName>)

function addListener<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

listener: Listener<{}, EventName>

المرتجعات

ModuleClient

موروث من InternalClient.addListener

complete(Message)

function complete(message: Message): Promise<MessageCompleted>

المعلمات

message: Message

المرتجعات

Promise<MessageCompleted>

موروث من InternalClient.complete

complete(Message, Callback<MessageCompleted>)

function complete(message: Message, completeCallback: Callback<MessageCompleted>)

المعلمات

message: Message

completeCallback: Callback<MessageCompleted>

موروث من InternalClient.complete

emit<EventName>(EventName, Args<{}, EventName>)

يستدعي بشكل متزامن كل من المستمعين المسجلين للحدث المسمى 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<EventName>(eventName: EventName, args: Args<{}, EventName>): boolean

المعلمات

eventName: EventName

args: Args<{}, EventName>

المرتجعات

boolean

موروث من InternalClient.emit

emit<EventName>(EventName, Args<{}, EventName>)

function emit<EventName>(eventName: EventName, args: Args<{}, EventName>): boolean

المعلمات

eventName: EventName

args: Args<{}, EventName>

المرتجعات

boolean

موروث من InternalClient.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)[]

موروث من InternalClient.eventNames

getEventListeners(EventEmitter<{}> | EventTarget, string | symbol)

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

المعلمات

emitter: EventEmitter<{}> | EventTarget

name: string | symbol

المرتجعات

Function[]

موروث من InternalClient.getEventListeners

getEventListeners<Events, EventName>(EventEmitter<Events>, EventName)

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

على سبيل EventEmitters يتصرف هذا تماما مثل استدعاء .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<Events, EventName>(emitter: EventEmitter<Events>, name: EventName): Listener<Events, EventName>[]

المعلمات

emitter: EventEmitter<Events>

name: EventName

المرتجعات

Listener<Events, EventName>[]

موروث من InternalClient.getEventListeners

getMaxListeners()

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

function getMaxListeners(): number

المرتجعات

number

موروثة من InternalClient.getMaxListeners

getMaxListeners(EventEmitter<{}> | EventTarget)

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

على سبيل EventEmitters يتصرف هذا تماما مثل استدعاء .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<{}> | EventTarget): number

المعلمات

emitter: EventEmitter<{}> | EventTarget

المرتجعات

number

موروثة من InternalClient.getMaxListeners

getTwin()

function getTwin(): Promise<Twin>

المرتجعات

Promise<Twin>

موروث من InternalClient.getTwin

getTwin(Callback<Twin>)

function getTwin(done: Callback<Twin>)

المعلمات

done: Callback<Twin>

موروث من InternalClient.getTwin

listenerCount(EventEmitter<{}>, 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<{}>, eventName: string | symbol): number

المعلمات

emitter: EventEmitter<{}>

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

eventName: string | symbol

اسم الحدث

المرتجعات

number

موروث من InternalClient.listenerCount

listenerCount<EventName>(EventName, Listener<{}, EventName>)

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

function listenerCount<EventName>(eventName: EventName, listener?: Listener<{}, EventName>): number

المعلمات

eventName: EventName

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

listener: Listener<{}, EventName>

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

المرتجعات

number

موروث من InternalClient.listenerCount

listenerCount<EventName>(EventName, Listener<{}, EventName>)

function listenerCount<EventName>(eventName: EventName, listener?: Listener<{}, EventName>): number

المعلمات

eventName: EventName

listener: Listener<{}, EventName>

المرتجعات

number

موروث من InternalClient.listenerCount

listenerCount<Events, EventName>(EventEmitter<Events>, EventName)

تحذير

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

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<Events, EventName>(emitter: EventEmitter<Events>, eventName: EventName): number

المعلمات

emitter: EventEmitter<Events>

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

eventName: EventName

اسم الحدث

المرتجعات

number

موروث من InternalClient.listenerCount

listeners<EventName>(EventName)

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

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

function listeners<EventName>(eventName: EventName): Listener<{}, EventName>[]

المعلمات

eventName: EventName

المرتجعات

Listener<{}, EventName>[]

موروثة من InternalClient.listeners

listeners<EventName>(EventName)

function listeners<EventName>(eventName: EventName): Listener<{}, EventName>[]

المعلمات

eventName: EventName

المرتجعات

Listener<{}, EventName>[]

موروثة من InternalClient.listeners

off<EventName>(EventName, Listener<{}, EventName>)

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

function off<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

listener: Listener<{}, EventName>

المرتجعات

ModuleClient

موروث من InternalClient.off

off<EventName>(EventName, Listener<{}, EventName>)

function off<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

listener: Listener<{}, EventName>

المرتجعات

ModuleClient

موروث من InternalClient.off

on(EventEmitter<{}>, string | symbol, StaticEventEmitterIteratorOptions)

static function on(emitter: EventEmitter<{}>, eventName: string | symbol, options?: StaticEventEmitterIteratorOptions): AsyncIterator<any[], any, any>

المعلمات

emitter: EventEmitter<{}>

eventName: string | symbol

options: StaticEventEmitterIteratorOptions

المرتجعات

AsyncIterator<any[], any, any>

موروث من InternalClient.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>

موروث من InternalClient.on

on<EventName>(EventName, Listener<{}, EventName>)

يضيف الدالة listener إلى نهاية صفيف المستمعين للحدث المسمى eventName. لا يتم إجراء أي فحوصات لمعرفة ما إذا كان قد تمت إضافة listener بالفعل. ستؤدي المكالمات المتعددة التي تمر بنفس المجموعة من eventNamelistener إلى إضافة 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<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

اسم الحدث.

listener: Listener<{}, EventName>

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

المرتجعات

ModuleClient

موروث من InternalClient.on

on<EventName>(EventName, Listener<{}, EventName>)

function on<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

listener: Listener<{}, EventName>

المرتجعات

ModuleClient

موروث من InternalClient.on

on<Events, EventName>(EventEmitter<Events>, EventName, 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<Events, EventName>(emitter: EventEmitter<Events>, eventName: EventName, options?: StaticEventEmitterIteratorOptions): AsyncIterator<Args<Events, EventName>, any, any>

المعلمات

emitter: EventEmitter<Events>

eventName: EventName

options: StaticEventEmitterIteratorOptions

المرتجعات

AsyncIterator<Args<Events, EventName>, any, any>

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

موروث من InternalClient.on

once(EventEmitter<{}>, string | symbol, StaticEventEmitterOptions)

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

المعلمات

emitter: EventEmitter<{}>

eventName: string | symbol

options: StaticEventEmitterOptions

المرتجعات

Promise<any[]>

موروث من InternalClient.once

once(EventTarget, string, StaticEventEmitterOptions)

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

المعلمات

emitter: EventTarget

eventName: string

options: StaticEventEmitterOptions

المرتجعات

Promise<any[]>

موروث من InternalClient.once

once<EventName>(EventName, 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<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

اسم الحدث.

listener: Listener<{}, EventName>

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

المرتجعات

ModuleClient

موروث من InternalClient.once

once<EventName>(EventName, Listener<{}, EventName>)

function once<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

listener: Listener<{}, EventName>

المرتجعات

ModuleClient

موروث من InternalClient.once

once<Events, EventName>(EventEmitter<Events>, EventName, 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<Events, EventName>(emitter: EventEmitter<Events>, eventName: EventName, options?: StaticEventEmitterOptions): Promise<Args<Events, EventName>>

المعلمات

emitter: EventEmitter<Events>

eventName: EventName

options: StaticEventEmitterOptions

المرتجعات

Promise<Args<Events, EventName>>

موروث من InternalClient.once

open()

function open(): Promise<Connected>

المرتجعات

Promise<Connected>

موروث من InternalClient.open

open(Callback<Connected>)

function open(openCallback: Callback<Connected>)

المعلمات

openCallback: Callback<Connected>

موروث من InternalClient.open

prependListener<EventName>(EventName, Listener<{}, EventName>)

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

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

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

function prependListener<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

اسم الحدث.

listener: Listener<{}, EventName>

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

المرتجعات

ModuleClient

موروث من InternalClient.prependListener

prependListener<EventName>(EventName, Listener<{}, EventName>)

function prependListener<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

listener: Listener<{}, EventName>

المرتجعات

ModuleClient

موروث من InternalClient.prependListener

prependOnceListener<EventName>(EventName, Listener<{}, EventName>)

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

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

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

function prependOnceListener<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

اسم الحدث.

listener: Listener<{}, EventName>

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

المرتجعات

ModuleClient

موروث من InternalClient.prependOnceListener

prependOnceListener<EventName>(EventName, Listener<{}, EventName>)

function prependOnceListener<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

listener: Listener<{}, EventName>

المرتجعات

ModuleClient

موروث من InternalClient.prependOnceListener

rawListeners<EventName>(EventName)

إرجاع نسخة من صفيف المستمعين للحدث المسمى 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<EventName>(eventName: EventName): Listener<{}, EventName>[]

المعلمات

eventName: EventName

المرتجعات

Listener<{}, EventName>[]

موروث من InternalClient.rawListeners

rawListeners<EventName>(EventName)

function rawListeners<EventName>(eventName: EventName): Listener<{}, EventName>[]

المعلمات

eventName: EventName

المرتجعات

Listener<{}, EventName>[]

موروث من InternalClient.rawListeners

reject(Message)

function reject(message: Message): Promise<MessageRejected>

المعلمات

message: Message

المرتجعات

Promise<MessageRejected>

موروث من InternalClient.reject

reject(Message, Callback<MessageRejected>)

function reject(message: Message, rejectCallback: Callback<MessageRejected>)

المعلمات

message: Message

rejectCallback: Callback<MessageRejected>

موروث من InternalClient.reject

removeAllListeners<EventName>(EventName)

إزالة كافة وحدات الاستماع، أو تلك الخاصة eventNameالمحددة.

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

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

function removeAllListeners<EventName>(eventName: EventName): ModuleClient

المعلمات

eventName: EventName

المرتجعات

ModuleClient

موروث من InternalClient.removeAllListeners

removeAllListeners<EventName>(EventName)

function removeAllListeners<EventName>(eventName?: EventName): ModuleClient

المعلمات

eventName: EventName

المرتجعات

ModuleClient

موروث من InternalClient.removeAllListeners

removeListener<EventName>(EventName, Listener<{}, EventName>)

يزيل 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<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

listener: Listener<{}, EventName>

المرتجعات

ModuleClient

موروث من InternalClient.removeListener

removeListener<EventName>(EventName, Listener<{}, EventName>)

function removeListener<EventName>(eventName: EventName, listener: Listener<{}, EventName>): ModuleClient

المعلمات

eventName: EventName

listener: Listener<{}, EventName>

المرتجعات

ModuleClient

موروث من InternalClient.removeListener

sendEvent(Message)

function sendEvent(message: Message): Promise<MessageEnqueued>

المعلمات

message: Message

المرتجعات

Promise<MessageEnqueued>

موروث من InternalClient.sendEvent

sendEvent(Message, Callback<MessageEnqueued>)

function sendEvent(message: Message, sendEventCallback: Callback<MessageEnqueued>)

المعلمات

message: Message

sendEventCallback: Callback<MessageEnqueued>

موروث من InternalClient.sendEvent

sendEventBatch(Message[])

function sendEventBatch(messages: Message[]): Promise<MessageEnqueued>

المعلمات

messages: Message[]

المرتجعات

Promise<MessageEnqueued>

موروث من InternalClient.sendEventBatch

sendEventBatch(Message[], Callback<MessageEnqueued>)

function sendEventBatch(messages: Message[], sendEventBatchCallback: Callback<MessageEnqueued>)

المعلمات

messages: Message[]

sendEventBatchCallback: Callback<MessageEnqueued>

موروث من InternalClient.sendEventBatch

setMaxListeners(number)

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

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

function setMaxListeners(n: number): ModuleClient

المعلمات

n: number

المرتجعات

ModuleClient

موروث من InternalClient.setMaxListeners

setMaxListeners(number, (EventEmitter<{}> | 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<{}> | EventTarget)[])

المعلمات

n: number

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

eventTargets: (EventEmitter<{}> | EventTarget)[]

صفر أو أكثر من مثيلات {EventTarget} أو {EventEmitter}. إذا لم يتم تحديد أي عنصر، يتم تعيين n كحد أقصى افتراضي لكافة كائنات {EventTarget} و{EventEmitter} التي تم إنشاؤها حديثا.

موروث من InternalClient.setMaxListeners

setRetryPolicy(RetryPolicy)

تعيين نهج إعادة المحاولة المستخدم من قبل العميل على جميع العمليات. الإعداد الافتراضي هو ExponentialBackoffWithJitter.

function setRetryPolicy(policy: RetryPolicy)

المعلمات

policy: RetryPolicy

{RetryPolicy} نهج إعادة المحاولة الذي يجب استخدامه لجميع العمليات المستقبلية.

موروث من InternalClient.setRetryPolicy

setTransportOptions(any)

function setTransportOptions(options: any): Promise<TransportConfigured>

المعلمات

options: any

المرتجعات

Promise<TransportConfigured>

موروث من InternalClient.setTransportOptions

setTransportOptions(any, Callback<TransportConfigured>)

function setTransportOptions(options: any, done: Callback<TransportConfigured>)

المعلمات

options: any

done: Callback<TransportConfigured>

موروث من InternalClient.setTransportOptions

updateSharedAccessSignature(string, Callback<SharedAccessSignatureUpdated>)

function updateSharedAccessSignature(sharedAccessSignature: string, updateSasCallback?: Callback<SharedAccessSignatureUpdated>)

المعلمات

sharedAccessSignature: string

updateSasCallback: Callback<SharedAccessSignatureUpdated>

موروث من InternalClient.updateSharedAccessSignature

[captureRejectionSymbol](Error, string | symbol, any[])

function [captureRejectionSymbol](error: Error, event: string | symbol, args: any[])

المعلمات

error: Error

event: string | symbol

args: any[]

موروث من InternalClient.__@captureRejectionSymbol@178

[captureRejectionSymbol]<EventName>(Error, EventName, Args<{}, EventName>)

function [captureRejectionSymbol]<EventName>(error: Error, event: EventName, args: Args<{}, EventName>)

المعلمات

error: Error

event: EventName

args: Args<{}, EventName>

موروث من InternalClient.__@captureRejectionSymbol@178

مشاركة عبر

ModuleClient class

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

الأساليب

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

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

captureRejections

قيمة الخاصية

captureRejectionSymbol

قيمة الخاصية

defaultMaxListeners

قيمة الخاصية

errorMonitor

قيمة الخاصية

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

close()

المرتجعات

close(Callback<Disconnected>)

المعلمات

fromAuthenticationProvider(AuthenticationProvider, any)

المعلمات

المرتجعات

fromConnectionString(string, any)

المعلمات

المرتجعات

fromEnvironment(any)

المعلمات

المرتجعات

fromEnvironment(any, Callback<ModuleClient>)

المعلمات

fromSharedAccessSignature(string, any)

المعلمات

المرتجعات

invokeMethod(string, MethodParams)

المعلمات

المرتجعات

invokeMethod(string, MethodParams, Callback<MethodResult>)

المعلمات

invokeMethod(string, string, MethodParams)

المعلمات

المرتجعات

invokeMethod(string, string, MethodParams, Callback<MethodResult>)

المعلمات

onMethod(string, DoubleValueCallback<DeviceMethodRequest, DeviceMethodResponse>)

المعلمات

sendOutputEvent(string, Message)

المعلمات

المرتجعات

sendOutputEvent(string, Message, Callback<MessageEnqueued>)

المعلمات

sendOutputEventBatch(string, Message[])

المعلمات

المرتجعات

sendOutputEventBatch(string, Message[], Callback<MessageEnqueued>)

المعلمات

setOptions(DeviceClientOptions)

المعلمات

المرتجعات

setOptions(DeviceClientOptions, Callback<TransportConfigured>)

المعلمات

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

abandon(Message)

المعلمات

المرتجعات

abandon(Message, Callback<MessageAbandoned>)

المعلمات

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

المعلمات

المرتجعات

addListener<EventName>(EventName, Listener<{}, EventName>)

المعلمات

المرتجعات

addListener<EventName>(EventName, Listener<{}, EventName>)

المعلمات

المرتجعات

complete(Message)

المعلمات

المرتجعات

complete(Message, Callback<MessageCompleted>)

المعلمات