Client class
Klien perangkat IoT Hub yang digunakan untuk menyambungkan perangkat dengan hub Azure IoT.
Pengguna SDK harus memanggil salah satu metode pabrik, dariConnectionString atau dari SharedAccessSignature untuk membuat klien perangkat IoT Hub.
- Memperluas
-
InternalClient
Konstruktor
Client(Device |
Properti yang Diwariskan
capture |
Nilai: boolean Ubah opsi |
capture |
Nilai: Lihat cara menulis |
default |
Secara default, maksimum pendengar Berhati-hatilah saat mengatur Ini bukan batas yang sulit. Instans
Bendera baris perintah Peringatan yang dipancarkan dapat diperiksa dengan |
error |
Simbol ini akan digunakan untuk menginstal pendengar hanya untuk memantau peristiwa Menginstal pendengar menggunakan simbol ini tidak mengubah perilaku setelah peristiwa |
Metode
close() | |
close(Callback<Disconnected>) | Menutup koneksi transportasi dan menghancurkan sumber daya klien. Catatan: Setelah memanggil metode ini, objek Klien tidak dapat digunakan kembali. |
from |
Membuat klien perangkat IoT Hub dari metode autentikasi yang diberikan dan menggunakan jenis transportasi yang diberikan. |
from |
Membuat klien perangkat IoT Hub dari string koneksi yang diberikan menggunakan jenis transportasi yang diberikan. |
from |
Membuat klien perangkat IoT Hub dari tanda tangan akses bersama yang diberikan menggunakan jenis transportasi yang diberikan. |
get |
|
get |
|
notify |
|
notify |
Metode |
on |
Mendaftarkan panggilan balik untuk metode bernama |
set |
|
set |
|
upload |
|
upload |
Metode |
Metode yang Diwarisi
abandon(Message) | |
abandon(Message, Callback<Message |
|
add |
Mendengarkan sekali untuk peristiwa Mendengarkan peristiwa API ini memungkinkan penggunaan Mengembalikan sekali pakai sehingga dapat dilepas langganannya dengan lebih mudah.
|
add |
Alias untuk |
complete(Message) | |
complete(Message, Callback<Message |
|
emit<K>(string | symbol, Any |
Secara sinkron memanggil masing-masing pendengar yang terdaftar untuk peristiwa bernama Mengembalikan
|
event |
Mengembalikan array yang mencantumkan peristiwa di mana pemancar telah mendaftarkan pendengar. Nilai dalam array adalah string atau
|
get |
Mengembalikan salinan array pendengar untuk peristiwa bernama Untuk Untuk
|
get |
Mengembalikan nilai pendengar maks saat ini untuk |
get |
Mengembalikan jumlah maksimum pendengar yang saat ini ditetapkan. Untuk Untuk
|
get |
|
get |
|
listener |
Metode kelas yang mengembalikan jumlah pendengar untuk
|
listener |
Mengembalikan jumlah pendengar yang mendengarkan peristiwa bernama |
listeners<K>(string | symbol) | Mengembalikan salinan array pendengar untuk peristiwa bernama
|
off<K>(string | symbol, (args: any[]) => void) | Alias untuk |
on(Event |
Mengembalikan
Gunakan opsi
|
on(Event |
|
on<K>(string | symbol, (args: any[]) => void) | Menambahkan fungsi
Mengembalikan referensi ke Secara default, pendengar peristiwa dipanggil dalam urutan ditambahkan. Metode
|
once(Event |
Membuat Metode ini sengaja generik dan bekerja dengan platform web antarmuka EventTarget, yang tidak memiliki semantik peristiwa
Penanganan khusus peristiwa
|
once(Event |
|
once<K>(string | symbol, (args: any[]) => void) | Menambahkan fungsi
Mengembalikan referensi ke Secara default, pendengar peristiwa dipanggil dalam urutan ditambahkan. Metode
|
open() | |
open(Callback<Connected>) | |
prepend |
Menambahkan fungsi
Mengembalikan referensi ke |
prepend |
Menambahkan fungsi
Mengembalikan referensi ke |
raw |
Mengembalikan salinan array pendengar untuk peristiwa bernama
|
reject(Message) | |
reject(Message, Callback<Message |
|
remove |
Menghapus semua pendengar, atau pendengar dari Adalah praktik buruk untuk menghapus listener yang ditambahkan di tempat lain dalam kode, terutama ketika instans Mengembalikan referensi ke |
remove |
Menghapus
Setelah peristiwa dipancarkan, semua pendengar yang melekat padanya pada saat pemancaran dipanggil secara berurutan. Ini menyiratkan bahwa setiap panggilan
Karena pendengar dikelola menggunakan array internal, memanggil ini akan mengubah indeks posisi pendengar mana pun yang terdaftar setelah pendengar dihapus. Ini tidak akan berdampak pada urutan di mana pendengar dipanggil, tetapi itu berarti bahwa salinan array pendengar seperti yang dikembalikan oleh metode Ketika satu fungsi telah ditambahkan sebagai handler beberapa kali untuk satu peristiwa (seperti dalam contoh di bawah),
Mengembalikan referensi ke |
send |
|
send |
|
send |
|
send |
|
set |
Secara default Mengembalikan referensi ke |
set |
|
set |
Mengatur kebijakan coba lagi yang digunakan oleh klien pada semua operasi. Defaultnya adalah ExponentialBackoffWithJitter. |
set |
|
set |
|
update |
|
[capture |
Detail Konstruktor
Client(DeviceTransport, string, BlobUploadClient, FileUploadInterface)
new Client(transport: DeviceTransport, connStr?: string, blobUploadClient?: BlobUploadClient, fileUploadApi?: FileUploadInterface)
Parameter
- transport
- DeviceTransport
Objek yang mengimplementasikan antarmuka yang diharapkan dari objek transportasi, misalnya, Http.
- connStr
-
string
String koneksi (opsional: jika tidak disediakan, updateSharedAccessSignature harus dipanggil untuk mengatur token SharedAccessSignature secara langsung).
- blobUploadClient
-
BlobUploadClient
Objek yang mampu mengunggah aliran ke blob.
- fileUploadApi
-
FileUploadInterface
Objek yang digunakan untuk berkomunikasi dengan IoT Hub untuk tindakan terkait Blob Storage.
Detail Properti yang Diwariskan
captureRejections
Nilai: boolean
Ubah opsi captureRejections
default pada semua objek EventEmitter
baru.
static captureRejections: boolean
Nilai Properti
boolean
Diwariskan Dari InternalClient.captureRejections
captureRejectionSymbol
Nilai: Symbol.for('nodejs.rejection')
Lihat cara menulis rejection handler
kustom .
static captureRejectionSymbol: typeof captureRejectionSymbol
Nilai Properti
typeof captureRejectionSymbol
Diwarisi Dari InternalClient.captureRejectionSymbol
defaultMaxListeners
Secara default, maksimum pendengar 10
dapat didaftarkan untuk setiap peristiwa tunggal. Batas ini dapat diubah untuk instans EventEmitter
individual menggunakan metode emitter.setMaxListeners(n)
. Untuk mengubah default untuk semua instansEventEmitter
, properti events.defaultMaxListeners
dapat digunakan. Jika nilai ini bukan angka positif, RangeError
akan dilemparkan.
Berhati-hatilah saat mengatur events.defaultMaxListeners
karena perubahan memengaruhi semua instansEventEmitter
, termasuk yang dibuat sebelum perubahan dilakukan. Namun, memanggil emitter.setMaxListeners(n)
masih lebih diutamakan daripada events.defaultMaxListeners
.
Ini bukan batas yang sulit. Instans EventEmitter
akan memungkinkan lebih banyak pendengar ditambahkan tetapi akan menghasilkan peringatan jejak ke stderr yang menunjukkan bahwa "kemungkinan kebocoran memori EventEmitter" telah terdeteksi. Untuk setiap EventEmitter
tunggal , metode emitter.getMaxListeners()
dan emitter.setMaxListeners()
dapat digunakan untuk sementara menghindari peringatan ini:
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));
});
Bendera baris perintah --trace-warnings
dapat digunakan untuk menampilkan jejak tumpukan untuk peringatan tersebut.
Peringatan yang dipancarkan dapat diperiksa dengan process.on('warning')
dan akan memiliki properti tambahan emitter
, type
, dan count
, masing-masing mengacu pada instans pemancar peristiwa, nama peristiwa, dan jumlah pendengar yang terpasang.
Properti name
diatur ke 'MaxListenersExceededWarning'
.
static defaultMaxListeners: number
Nilai Properti
number
Diwarisi Dari InternalClient.defaultMaxListeners
errorMonitor
Simbol ini akan digunakan untuk menginstal pendengar hanya untuk memantau peristiwa 'error'
. Listener yang diinstal menggunakan simbol ini dipanggil sebelum listener 'error'
biasa dipanggil.
Menginstal pendengar menggunakan simbol ini tidak mengubah perilaku setelah peristiwa 'error'
dipancarkan. Oleh karena itu, prosesnya masih akan crash jika tidak ada listener 'error'
reguler yang diinstal.
static errorMonitor: typeof errorMonitor
Nilai Properti
typeof errorMonitor
Diwariskan Dari InternalClient.errorMonitor
Detail Metode
close()
function close(): Promise<Disconnected>
Mengembalikan
Promise<Disconnected>
close(Callback<Disconnected>)
Menutup koneksi transportasi dan menghancurkan sumber daya klien.
Catatan: Setelah memanggil metode ini, objek Klien tidak dapat digunakan kembali.
function close(closeCallback?: Callback<Disconnected>)
Parameter
- closeCallback
-
Callback<Disconnected>
Fungsi opsional untuk memanggil setelah transportasi terputus dan klien ditutup.
fromAuthenticationProvider(AuthenticationProvider, any)
Membuat klien perangkat IoT Hub dari metode autentikasi yang diberikan dan menggunakan jenis transportasi yang diberikan.
static function fromAuthenticationProvider(authenticationProvider: AuthenticationProvider, transportCtor: any): Client
Parameter
- authenticationProvider
-
AuthenticationProvider
Objek yang digunakan untuk mendapatkan parameter autentikasi untuk hub IoT.
- transportCtor
-
any
Protokol transportasi yang digunakan untuk menyambungkan ke hub IoT.
Mengembalikan
fromConnectionString(string, any)
Membuat klien perangkat IoT Hub dari string koneksi yang diberikan menggunakan jenis transportasi yang diberikan.
static function fromConnectionString(connStr: string, transportCtor: any): Client
Parameter
- connStr
-
string
String koneksi yang merangkum izin "device connect" pada hub IoT.
- transportCtor
-
any
Konstruktor transportasi.
Mengembalikan
fromSharedAccessSignature(string, any)
Membuat klien perangkat IoT Hub dari tanda tangan akses bersama yang diberikan menggunakan jenis transportasi yang diberikan.
static function fromSharedAccessSignature(sharedAccessSignature: string, transportCtor: any): Client
Parameter
- sharedAccessSignature
-
string
Tanda tangan akses bersama yang merangkum izin "koneksi perangkat" di hub IoT.
- transportCtor
-
any
Mengembalikan
getBlobSharedAccessSignature(string)
function getBlobSharedAccessSignature(blobName: string): Promise<UploadParams>
Parameter
- blobName
-
string
Mengembalikan
Promise<UploadParams>
getBlobSharedAccessSignature(string, Callback<UploadParams>)
getBlobSharedAccessSignature
mendapatkan Token SAS akun penyimpanan tertaut dari IoT Hub
function getBlobSharedAccessSignature(blobName: string, callback?: Callback<UploadParams>)
Parameter
- blobName
-
string
Nama yang akan digunakan untuk blob yang akan dibuat dengan konten aliran.
- callback
-
Callback<UploadParams>
Panggilan balik opsional untuk memanggil saat pengunggahan selesai.
notifyBlobUploadStatus(string, boolean, number, string)
function notifyBlobUploadStatus(correlationId: string, isSuccess: boolean, statusCode: number, statusDescription: string): Promise<void>
Parameter
- correlationId
-
string
- isSuccess
-
boolean
- statusCode
-
number
- statusDescription
-
string
Mengembalikan
Promise<void>
notifyBlobUploadStatus(string, boolean, number, string, ErrorCallback)
Metode notifyBlobUploadStatus
mengirimkan IoT Hub hasil unggahan blob.
function notifyBlobUploadStatus(correlationId: string, isSuccess: boolean, statusCode: number, statusDescription: string, callback?: ErrorCallback)
Parameter
- correlationId
-
string
Id untuk menghubungkan status unggahan ke blob tertentu. Dihasilkan selama panggilan ke getBlobSharedAccessSignature
.
- isSuccess
-
boolean
Status keberhasilan atau kegagalan dari hasil operasi blob penyimpanan.
- statusCode
-
number
Kode status HTTP yang terkait dengan hasil blob penyimpanan.
- statusDescription
-
string
Deskripsi kode status HTTP.
- callback
-
ErrorCallback
Panggilan balik opsional untuk memanggil saat pengunggahan selesai.
onDeviceMethod(string, (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)
Mendaftarkan panggilan balik untuk metode bernama methodName
.
function onDeviceMethod(methodName: string, callback: (request: DeviceMethodRequest, response: DeviceMethodResponse) => void)
Parameter
- methodName
-
string
Nama metode yang akan ditangani oleh panggilan balik
- callback
-
(request: DeviceMethodRequest, response: DeviceMethodResponse) => void
Fungsi yang akan dipanggil setiap kali permintaan metode untuk metode yang disebut methodName
diterima.
setOptions(DeviceClientOptions)
function setOptions(options: DeviceClientOptions): Promise<TransportConfigured>
Parameter
- options
- DeviceClientOptions
Mengembalikan
Promise<TransportConfigured>
setOptions(DeviceClientOptions, Callback<TransportConfigured>)
function setOptions(options: DeviceClientOptions, done: Callback<TransportConfigured>)
Parameter
- options
- DeviceClientOptions
- done
-
Callback<TransportConfigured>
uploadToBlob(string, Stream, number)
function uploadToBlob(blobName: string, stream: Stream, streamLength: number): Promise<void>
Parameter
- blobName
-
string
- stream
-
Stream
- streamLength
-
number
Mengembalikan
Promise<void>
uploadToBlob(string, Stream, number, ErrorCallback)
Metode uploadToBlob
mengunggah aliran ke blob.
function uploadToBlob(blobName: string, stream: Stream, streamLength: number, callback: ErrorCallback)
Parameter
- blobName
-
string
Nama yang akan digunakan untuk blob yang akan dibuat dengan konten aliran.
- stream
-
Stream
Data ke yang harus diunggah ke blob.
- streamLength
-
number
Ukuran data yang harus diunggah ke blob.
- callback
-
ErrorCallback
Detail Metode yang Diwarisi
abandon(Message)
function abandon(message: Message): Promise<MessageAbandoned>
Parameter
- message
- Message
Mengembalikan
Promise<MessageAbandoned>
Diwariskan Dari InternalClient.abandon
abandon(Message, Callback<MessageAbandoned>)
function abandon(message: Message, abandonCallback: Callback<MessageAbandoned>)
Parameter
- message
- Message
- abandonCallback
-
Callback<MessageAbandoned>
Diwariskan Dari InternalClient.abandon
addAbortListener(AbortSignal, (event: Event) => void)
Mendengarkan sekali untuk peristiwa abort
pada signal
yang disediakan.
Mendengarkan peristiwa abort
pada sinyal batalkan tidak aman dan dapat menyebabkan kebocoran sumber daya karena pihak ketiga lain dengan sinyal dapat memanggil e.stopImmediatePropagation()
. Sayangnya Node.js tidak dapat mengubah ini karena akan melanggar standar web. Selain itu, API asli memudahkan untuk lupa menghapus pendengar.
API ini memungkinkan penggunaan AbortSignal
dengan aman di API Node.js dengan memecahkan dua masalah ini dengan mendengarkan peristiwa-sehingga stopImmediatePropagation
tidak mencegah pendengar berjalan.
Mengembalikan sekali pakai sehingga dapat dilepas langganannya dengan lebih mudah.
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
Parameter
- signal
-
AbortSignal
- resource
-
(event: Event) => void
Mengembalikan
Disposable
Sekali pakai yang menghapus pendengar abort
.
Diwariskan Dari InternalClient.addAbortListener
addListener<K>(string | symbol, (args: any[]) => void)
Alias untuk emitter.on(eventName, listener)
.
function addListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Parameter
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Mengembalikan
Diwariskan Dari InternalClient.addListener
complete(Message)
function complete(message: Message): Promise<MessageCompleted>
Parameter
- message
- Message
Mengembalikan
Promise<MessageCompleted>
Diwarisi Dari InternalClient.complete
complete(Message, Callback<MessageCompleted>)
function complete(message: Message, completeCallback: Callback<MessageCompleted>)
Parameter
- message
- Message
- completeCallback
-
Callback<MessageCompleted>
Diwarisi Dari InternalClient.complete
emit<K>(string | symbol, AnyRest)
Secara sinkron memanggil masing-masing pendengar yang terdaftar untuk peristiwa bernama eventName
, dalam urutan terdaftar, meneruskan argumen yang disediakan ke masing-masing.
Mengembalikan true
jika peristiwa memiliki pendengar, false
sebaliknya.
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
Parameter
- eventName
-
string | symbol
- args
-
AnyRest
Mengembalikan
boolean
Diwariskan Dari InternalClient.emit
eventNames()
Mengembalikan array yang mencantumkan peristiwa di mana pemancar telah mendaftarkan pendengar. Nilai dalam array adalah string atau 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)[]
Mengembalikan
(string | symbol)[]
Diwariskan Dari InternalClient.eventNames
getEventListeners(EventEmitter<DefaultEventMap> | EventTarget, string | symbol)
Mengembalikan salinan array pendengar untuk peristiwa bernama eventName
.
Untuk EventEmitter
, perilaku ini sama persis dengan memanggil .listeners
pada emiter.
Untuk EventTarget
ini adalah satu-satunya cara untuk mendapatkan pendengar acara untuk target peristiwa. Ini berguna untuk penelusuran kesalahan dan tujuan diagnostik.
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[]
Parameter
- emitter
-
EventEmitter<DefaultEventMap> | EventTarget
- name
-
string | symbol
Mengembalikan
Function[]
Diwariskan Dari InternalClient.getEventListeners
getMaxListeners()
Mengembalikan nilai pendengar maks saat ini untuk EventEmitter
yang diatur oleh emitter.setMaxListeners(n)
atau default ke defaultMaxListeners.
function getMaxListeners(): number
Mengembalikan
number
Diwariskan Dari InternalClient.getMaxListeners
getMaxListeners(EventEmitter<DefaultEventMap> | EventTarget)
Mengembalikan jumlah maksimum pendengar yang saat ini ditetapkan.
Untuk EventEmitter
, perilaku ini sama persis dengan memanggil .getMaxListeners
pada emiter.
Untuk EventTarget
ini adalah satu-satunya cara untuk mendapatkan pendengar peristiwa maksimum untuk target peristiwa. Jika jumlah penanganan aktivitas pada satu EventTarget melebihi set maksimum, EventTarget akan mencetak peringatan.
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
Parameter
- emitter
-
EventEmitter<DefaultEventMap> | EventTarget
Mengembalikan
number
Diwariskan Dari InternalClient.getMaxListeners
getTwin()
getTwin(Callback<Twin>)
function getTwin(done: Callback<Twin>)
Parameter
- done
-
Callback<Twin>
Diwarisi Dari InternalClient.getTwin
listenerCount(EventEmitter<DefaultEventMap>, string | symbol)
Peringatan
API ini sudah tidak digunakan lagi.
Since v3.2.0 - Use listenerCount
instead.
Metode kelas yang mengembalikan jumlah pendengar untuk eventName
yang diberikan yang terdaftar pada emitter
yang diberikan .
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
Parameter
- emitter
-
EventEmitter<DefaultEventMap>
Pemancar ke kueri
- eventName
-
string | symbol
Nama peristiwa
Mengembalikan
number
Diwarisi Dari InternalClient.listenerCount
listenerCount<K>(string | symbol, Function)
Mengembalikan jumlah pendengar yang mendengarkan peristiwa bernama eventName
.
Jika listener
disediakan, itu akan mengembalikan berapa kali pendengar ditemukan dalam daftar pendengar acara.
function listenerCount<K>(eventName: string | symbol, listener?: Function): number
Parameter
- eventName
-
string | symbol
Nama peristiwa yang sedang didengarkan
- listener
-
Function
Fungsi penanganan aktivitas
Mengembalikan
number
Diwarisi Dari InternalClient.listenerCount
listeners<K>(string | symbol)
Mengembalikan salinan array pendengar untuk peristiwa bernama 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[]
Parameter
- eventName
-
string | symbol
Mengembalikan
Function[]
Diwariskan Dari InternalClient.listeners
off<K>(string | symbol, (args: any[]) => void)
Alias untuk emitter.removeListener()
.
function off<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Parameter
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Mengembalikan
Diwariskan Dari InternalClient.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
Mengembalikan AsyncIterator
yang mengulangi peristiwa eventName
. Ini akan melemparkan jika EventEmitter
memancarkan 'error'
. Ini menghapus semua listener saat keluar dari perulangan.
value
yang dikembalikan oleh setiap iterasi adalah array yang terdiri dari argumen peristiwa yang dipancarkan.
AbortSignal
dapat digunakan untuk membatalkan menunggu acara:
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());
Gunakan opsi close
untuk menentukan array nama peristiwa yang akan mengakhiri iterasi:
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): AsyncIterableIterator<any[]>
Parameter
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string | symbol
- options
-
StaticEventEmitterIteratorOptions
Mengembalikan
AsyncIterableIterator<any[]>
AsyncIterator
yang mengulangi peristiwa eventName
yang dipancarkan oleh emitter
Diwariskan Dari InternalClient.on
on(EventTarget, string, StaticEventEmitterIteratorOptions)
static function on(emitter: EventTarget, eventName: string, options?: StaticEventEmitterIteratorOptions): AsyncIterableIterator<any[]>
Parameter
- emitter
-
EventTarget
- eventName
-
string
- options
-
StaticEventEmitterIteratorOptions
Mengembalikan
AsyncIterableIterator<any[]>
Diwariskan Dari InternalClient.on
on<K>(string | symbol, (args: any[]) => void)
Menambahkan fungsi listener
ke akhir array pendengar untuk peristiwa bernama eventName
. Tidak ada pemeriksaan yang dilakukan untuk melihat apakah listener
telah ditambahkan. Beberapa panggilan yang melewati kombinasi eventName
dan listener
yang sama akan mengakibatkan listener
ditambahkan, dan dipanggil, beberapa kali.
server.on('connection', (stream) => {
console.log('someone connected!');
});
Mengembalikan referensi ke EventEmitter
, sehingga panggilan dapat ditautkan.
Secara default, pendengar peristiwa dipanggil dalam urutan ditambahkan. Metode emitter.prependListener()
dapat digunakan sebagai alternatif untuk menambahkan pendengar peristiwa ke awal array pendengar.
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
Parameter
- eventName
-
string | symbol
Nama peristiwa.
- listener
-
(args: any[]) => void
Fungsi panggilan balik
Mengembalikan
Diwariskan Dari InternalClient.on
once(EventEmitter<DefaultEventMap>, string | symbol, StaticEventEmitterOptions)
Membuat Promise
yang terpenuhi ketika EventEmitter
memancarkan peristiwa yang diberikan atau yang ditolak jika EventEmitter
mengeluarkan 'error'
saat menunggu.
Promise
akan diselesaikan dengan array semua argumen yang dipancarkan ke peristiwa yang diberikan.
Metode ini sengaja generik dan bekerja dengan platform web antarmuka EventTarget, yang tidak memiliki semantik peristiwa'error'
khusus dan tidak mendengarkan peristiwa '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);
}
Penanganan khusus peristiwa 'error'
hanya digunakan ketika events.once()
digunakan untuk menunggu peristiwa lain. Jika events.once()
digunakan untuk menunggu peristiwa 'error'
itu sendiri, maka itu diperlakukan sebagai jenis peristiwa lain tanpa penanganan khusus:
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
dapat digunakan untuk membatalkan menunggu acara:
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[]>
Parameter
- emitter
-
EventEmitter<DefaultEventMap>
- eventName
-
string | symbol
- options
-
StaticEventEmitterOptions
Mengembalikan
Promise<any[]>
Diwariskan Dari InternalClient.once
once(EventTarget, string, StaticEventEmitterOptions)
static function once(emitter: EventTarget, eventName: string, options?: StaticEventEmitterOptions): Promise<any[]>
Parameter
- emitter
-
EventTarget
- eventName
-
string
- options
-
StaticEventEmitterOptions
Mengembalikan
Promise<any[]>
Diwariskan Dari InternalClient.once
once<K>(string | symbol, (args: any[]) => void)
Menambahkan fungsieventName
dipicu, pendengar ini dihapus lalu dipanggil.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Mengembalikan referensi ke EventEmitter
, sehingga panggilan dapat ditautkan.
Secara default, pendengar peristiwa dipanggil dalam urutan ditambahkan. Metode emitter.prependOnceListener()
dapat digunakan sebagai alternatif untuk menambahkan pendengar peristiwa ke awal array pendengar.
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
Parameter
- eventName
-
string | symbol
Nama peristiwa.
- listener
-
(args: any[]) => void
Fungsi panggilan balik
Mengembalikan
Diwariskan Dari InternalClient.once
open()
function open(): Promise<Connected>
Mengembalikan
Promise<Connected>
Diwariskan Dari InternalClient.open
open(Callback<Connected>)
function open(openCallback: Callback<Connected>)
Parameter
- openCallback
-
Callback<Connected>
Diwariskan Dari InternalClient.open
prependListener<K>(string | symbol, (args: any[]) => void)
Menambahkan fungsi listener
telah ditambahkan. Beberapa panggilan yang melewati kombinasi eventName
dan listener
yang sama akan mengakibatkan listener
ditambahkan, dan dipanggil, beberapa kali.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Mengembalikan referensi ke EventEmitter
, sehingga panggilan dapat ditautkan.
function prependListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Parameter
- eventName
-
string | symbol
Nama peristiwa.
- listener
-
(args: any[]) => void
Fungsi panggilan balik
Mengembalikan
Diwariskan Dari InternalClient.prependListener
prependOnceListener<K>(string | symbol, (args: any[]) => void)
Menambahkan fungsieventName
dipicu, pendengar ini dihapus, lalu dipanggil.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Mengembalikan referensi ke EventEmitter
, sehingga panggilan dapat ditautkan.
function prependOnceListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Parameter
- eventName
-
string | symbol
Nama peristiwa.
- listener
-
(args: any[]) => void
Fungsi panggilan balik
Mengembalikan
Diwariskan Dari InternalClient.prependOnceListener
rawListeners<K>(string | symbol)
Mengembalikan salinan array pendengar untuk peristiwa bernama eventName
, termasuk pembungkus apa pun (seperti yang dibuat oleh .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[]
Parameter
- eventName
-
string | symbol
Mengembalikan
Function[]
Diwariskan Dari InternalClient.rawListeners
reject(Message)
function reject(message: Message): Promise<MessageRejected>
Parameter
- message
- Message
Mengembalikan
Promise<MessageRejected>
Diwariskan Dari InternalClient.reject
reject(Message, Callback<MessageRejected>)
function reject(message: Message, rejectCallback: Callback<MessageRejected>)
Parameter
- message
- Message
- rejectCallback
-
Callback<MessageRejected>
Diwariskan Dari InternalClient.reject
removeAllListeners(string | symbol)
Menghapus semua pendengar, atau pendengar dari eventName
yang ditentukan.
Adalah praktik buruk untuk menghapus listener yang ditambahkan di tempat lain dalam kode, terutama ketika instans EventEmitter
dibuat oleh beberapa komponen atau modul lain (misalnya soket atau aliran file).
Mengembalikan referensi ke EventEmitter
, sehingga panggilan dapat ditautkan.
function removeAllListeners(eventName?: string | symbol): Client
Parameter
- eventName
-
string | symbol
Mengembalikan
Diwariskan Dari InternalClient.removeAllListeners
removeListener<K>(string | symbol, (args: any[]) => void)
Menghapus listener
yang ditentukan dari array pendengar untuk peristiwa bernama eventName
.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener()
akan menghapus, paling banyak, satu instans pendengar dari array pendengar. Jika ada pendengar tunggal yang telah ditambahkan beberapa kali ke array pendengar untuk eventName
yang ditentukan, maka removeListener()
harus dipanggil beberapa kali untuk menghapus setiap instans.
Setelah peristiwa dipancarkan, semua pendengar yang melekat padanya pada saat pemancaran dipanggil secara berurutan. Ini menyiratkan bahwa setiap panggilan removeListener()
atau removeAllListeners()
setelah memancarkan dan sebelum pendengar terakhir menyelesaikan eksekusi tidak akan menghapusnya dariemit()
sedang berlangsung. Peristiwa berikutnya berulah seperti yang diharapkan.
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
Karena pendengar dikelola menggunakan array internal, memanggil ini akan mengubah indeks posisi pendengar mana pun yang terdaftar setelah pendengar dihapus. Ini tidak akan berdampak pada urutan di mana pendengar dipanggil, tetapi itu berarti bahwa salinan array pendengar seperti yang dikembalikan oleh metode emitter.listeners()
perlu dibuat ulang.
Ketika satu fungsi telah ditambahkan sebagai handler beberapa kali untuk satu peristiwa (seperti dalam contoh di bawah), removeListener()
akan menghapus instans yang terakhir ditambahkan. Dalam contoh pendengar once('ping')
dihapus:
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');
Mengembalikan referensi ke EventEmitter
, sehingga panggilan dapat ditautkan.
function removeListener<K>(eventName: string | symbol, listener: (args: any[]) => void): Client
Parameter
- eventName
-
string | symbol
- listener
-
(args: any[]) => void
Mengembalikan
Diwariskan Dari InternalClient.removeListener
sendEvent(Message)
function sendEvent(message: Message): Promise<MessageEnqueued>
Parameter
- message
- Message
Mengembalikan
Promise<MessageEnqueued>
Diwarisi Dari InternalClient.sendEvent
sendEvent(Message, Callback<MessageEnqueued>)
function sendEvent(message: Message, sendEventCallback: Callback<MessageEnqueued>)
Parameter
- message
- Message
- sendEventCallback
-
Callback<MessageEnqueued>
Diwarisi Dari InternalClient.sendEvent
sendEventBatch(Message[])
function sendEventBatch(messages: Message[]): Promise<MessageEnqueued>
Parameter
- messages
-
Message[]
Mengembalikan
Promise<MessageEnqueued>
Diwarisi Dari InternalClient.sendEventBatch
sendEventBatch(Message[], Callback<MessageEnqueued>)
function sendEventBatch(messages: Message[], sendEventBatchCallback: Callback<MessageEnqueued>)
Parameter
- messages
-
Message[]
- sendEventBatchCallback
-
Callback<MessageEnqueued>
Diwarisi Dari InternalClient.sendEventBatch
setMaxListeners(number)
Secara default EventEmitter
akan mencetak peringatan jika lebih dari 10
pendengar ditambahkan untuk peristiwa tertentu. Ini adalah default yang berguna yang membantu menemukan kebocoran memori. Metode emitter.setMaxListeners()
memungkinkan batas untuk dimodifikasi untuk instans EventEmitter
spesifik ini. Nilai dapat diatur ke Infinity
(atau 0
) untuk menunjukkan jumlah listener yang tidak terbatas.
Mengembalikan referensi ke EventEmitter
, sehingga panggilan dapat ditautkan.
function setMaxListeners(n: number): Client
Parameter
- n
-
number
Mengembalikan
Diwarisi Dari InternalClient.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)[])
Parameter
- n
-
number
Angka non-negatif. Jumlah maksimum pendengar per peristiwa EventTarget
.
- eventTargets
-
(EventEmitter<DefaultEventMap> | EventTarget)[]
Diwarisi Dari InternalClient.setMaxListeners
setRetryPolicy(RetryPolicy)
Mengatur kebijakan coba lagi yang digunakan oleh klien pada semua operasi. Defaultnya adalah ExponentialBackoffWithJitter.
function setRetryPolicy(policy: RetryPolicy)
Parameter
- policy
-
RetryPolicy
{RetryPolicy} Kebijakan coba lagi yang harus digunakan untuk semua operasi di masa mendatang.
Diwariskan Dari InternalClient.setRetryPolicy
setTransportOptions(any)
function setTransportOptions(options: any): Promise<TransportConfigured>
Parameter
- options
-
any
Mengembalikan
Promise<TransportConfigured>
Diwarisi Dari InternalClient.setTransportOptions
setTransportOptions(any, Callback<TransportConfigured>)
function setTransportOptions(options: any, done: Callback<TransportConfigured>)
Parameter
- options
-
any
- done
-
Callback<TransportConfigured>
Diwarisi Dari InternalClient.setTransportOptions
updateSharedAccessSignature(string, Callback<SharedAccessSignatureUpdated>)
function updateSharedAccessSignature(sharedAccessSignature: string, updateSasCallback?: Callback<SharedAccessSignatureUpdated>)
Parameter
- sharedAccessSignature
-
string
- updateSasCallback
-
Callback<SharedAccessSignatureUpdated>
Diwarisi Dari InternalClient.updateSharedAccessSignature
[captureRejectionSymbol]<K>(Error, string | symbol, AnyRest)
function [captureRejectionSymbol]<K>(error: Error, event: string | symbol, args: AnyRest)
Parameter
- error
-
Error
- event
-
string | symbol
- args
-
AnyRest
Diwariskan Dari InternalClient.__@captureRejectionSymbol@142