ServiceBusReceiverOptions interface

Paket:

@azure/service-bus

Opsi untuk digunakan saat membuat penerima.

Properti

identifier	Mengatur nama untuk mengidentifikasi penerima. Ini dapat digunakan untuk menghubungkan log dan pengecualian. Jika tidak ditentukan atau kosong, yang unik acak akan digunakan.
maxAutoLockRenewalDurationInMs	Durasi maksimum, dalam milidetik, bahwa kunci pada pesan akan diperbarui secara otomatis oleh klien. Perpanjangan otomatis ini berhenti setelah pesan diselesaikan. Default: 300 * 1000 milidetik (5 menit). Untuk menonaktifkan perpanjangan blok otomatis, atur ini ke 0. Contoh: Jika kunci pesan kedaluwarsa dalam 2 menit dan waktu pemrosesan pesan Anda adalah 8 menit... Atur maxAutoLockRenewalDurationInMs ke 10 menit, dan kunci pesan akan diperbarui secara otomatis selama 4 kali (setara dengan pesan yang dikunci selama 4 kali durasi kuncinya dengan memanfaatkan perpanjangan kunci).
receiveMode	Mewakili mode terima untuk penerima. Dalam mode receiveAndDelete, pesan dihapus dari Azure Service Bus saat diterima. Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean/langganan. Pesan yang tidak diselesaikan dalam durasi kunci akan dikirim ulang sebanyak jumlah pengiriman maksimum yang ditetapkan pada antrean/langganan, setelah itu mereka dikirim ke antrean dead letter terpisah. Anda dapat menyelesaikan pesan dengan memanggil metode complete(), abandon(), defer() atau deadletter() pada pesan. Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock
skipConvertingDate	Apakah akan melewati konversi jenis Tanggal pada properti anotasi pesan atau properti aplikasi menjadi angka saat menerima pesan. Secara default, properti jenis Tanggal dikonversi menjadi nomor epoch UNIX untuk kompatibilitas.
skipParsingBodyAsJson	Opsi untuk menonaktifkan klien agar tidak menjalankan JSON.parse() pada isi pesan saat menerima pesan. Tidak berlaku jika pesan dikirim dengan nilai atau urutan jenis isi AMQP. Gunakan opsi ini ketika Anda lebih suka bekerja langsung dengan byte yang ada di isi pesan daripada meminta klien mencoba mengurainya.
subQueueType	Mewakili sub antrean yang berlaku untuk antrean atau langganan apa pun. Nilai yang valid adalah "deadLetter" dan "transferDeadLetter". Untuk mempelajari selengkapnya tentang antrean surat mati, lihat https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

Detail Properti

identifier

Mengatur nama untuk mengidentifikasi penerima. Ini dapat digunakan untuk menghubungkan log dan pengecualian. Jika tidak ditentukan atau kosong, yang unik acak akan digunakan.

identifier?: string

Nilai Properti

string

maxAutoLockRenewalDurationInMs

Durasi maksimum, dalam milidetik, bahwa kunci pada pesan akan diperbarui secara otomatis oleh klien. Perpanjangan otomatis ini berhenti setelah pesan diselesaikan.

• Default: 300 * 1000 milidetik (5 menit).
• Untuk menonaktifkan perpanjangan blok otomatis, atur ini ke 0.

Contoh:

Jika kunci pesan kedaluwarsa dalam 2 menit dan waktu pemrosesan pesan Anda adalah 8 menit...

Atur maxAutoLockRenewalDurationInMs ke 10 menit, dan kunci pesan akan diperbarui secara otomatis selama 4 kali (setara dengan pesan yang dikunci selama 4 kali durasi kuncinya dengan memanfaatkan perpanjangan kunci).

maxAutoLockRenewalDurationInMs?: number

Nilai Properti

number

receiveMode

Mewakili mode terima untuk penerima.

Dalam mode receiveAndDelete, pesan dihapus dari Azure Service Bus saat diterima.

Dalam mode peekLock, penerima memiliki kunci pada pesan selama durasi yang ditentukan pada antrean/langganan.

Pesan yang tidak diselesaikan dalam durasi kunci akan dikirim ulang sebanyak jumlah pengiriman maksimum yang ditetapkan pada antrean/langganan, setelah itu mereka dikirim ke antrean dead letter terpisah.

Anda dapat menyelesaikan pesan dengan memanggil metode complete(), abandon(), defer() atau deadletter() pada pesan.

Informasi selengkapnya tentang cara kerja peekLock dan penyelesaian pesan di sini: https://docs.microsoft.com/azure/service-bus-messaging/message-transfers-locks-settlement#peeklock

receiveMode?: "peekLock" | "receiveAndDelete"

Nilai Properti

"peekLock" | "receiveAndDelete"

skipConvertingDate

Apakah akan melewati konversi jenis Tanggal pada properti anotasi pesan atau properti aplikasi menjadi angka saat menerima pesan. Secara default, properti jenis Tanggal dikonversi menjadi nomor epoch UNIX untuk kompatibilitas.

skipConvertingDate?: boolean

Nilai Properti

boolean

skipParsingBodyAsJson

Opsi untuk menonaktifkan klien agar tidak menjalankan JSON.parse() pada isi pesan saat menerima pesan. Tidak berlaku jika pesan dikirim dengan nilai atau urutan jenis isi AMQP. Gunakan opsi ini ketika Anda lebih suka bekerja langsung dengan byte yang ada di isi pesan daripada meminta klien mencoba mengurainya.

skipParsingBodyAsJson?: boolean

Nilai Properti

boolean

subQueueType

Mewakili sub antrean yang berlaku untuk antrean atau langganan apa pun. Nilai yang valid adalah "deadLetter" dan "transferDeadLetter". Untuk mempelajari selengkapnya tentang antrean surat mati, lihat https://docs.microsoft.com/azure/service-bus-messaging/service-bus-dead-letter-queues

subQueueType?: "deadLetter" | "transferDeadLetter"

Nilai Properti

"deadLetter" | "transferDeadLetter"