Package version:
Path of the entity for which the sender has been created.
A name used to identify the sender. This can be used to correlate logs and exceptions. If not specified or empty, a random unique one will be generated.
Readonly
isReturns true
if either the sender or the client that created it has been closed.
Cancels multiple messages that were scheduled to appear on a ServiceBus Queue/Subscription.
Sequence number or an array of sequence numbers of the messages to be cancelled.
Optional
options: OperationOptionsBaseOptions bag to pass an abort signal or tracing options.
Error if the underlying connection, client or sender is closed.
ServiceBusError
if the service returns an error while canceling scheduled messages.
Creates an instance of ServiceBusMessageBatch
to which one can add messages until the maximum supported size is reached.
The batch can be passed to the send method to send the messages to Azure Service Bus.
Optional
options: CreateMessageBatchOptionsConfigures the behavior of the batch.
maxSizeInBytes
: The upper limit for the size of batch. The tryAdd
function will return false
after this limit is reached.ServiceBusError
if an error is encountered while sending a message.
Error if the underlying connection or sender has been closed.
Schedules given messages to appear on Service Bus Queue/Subscription at a later time.
Message or an array of messages that need to be scheduled.
The UTC time at which the messages should be enqueued.
Optional
options: OperationOptionsBaseOptions bag to pass an abort signal or tracing options.
The sequence numbers of messages that were scheduled.
You will need the sequence number if you intend to cancel the scheduling of the messages.
Save the Long
type as-is in your application without converting to number. Since JavaScript
only supports 53 bit numbers, converting the Long
to number will cause loss in precision.
Error if the underlying connection, client or sender is closed.
ServiceBusError
if the service returns an error while scheduling messages.
Sends the given messages after creating an AMQP Sender link if it doesn't already exist.
session
and/or partition
enabled Queue/Topic, set the sessionId
and/or partitionKey
properties respectively on the messages.sessionId
(if using
sessions) and the same partitionKey
(if using partitions).Note:
If you want to send messages of size greater than 1MB, please send individual messages instead of sending a batched message or an array of messages like below.
await sender.sendMessages(message);
This is because the batched messages are not capable of sending the larger messages yet. You'll hit the force detached
error in this case otherwise. Read service-bus-premium-messaging#large-messages-support. More info at #23014.
A single message or an array of messages or a batch of messages created via the createBatch() method to send.
Optional
options: OperationOptionsBaseOptions bag to pass an abort signal or tracing options.
ServiceBusError
with the code MessageSizeExceeded
if the provided messages do not fit in a single ServiceBusMessageBatch
.
Error if the underlying connection, client or sender is closed.
ServiceBusError
if the service returns an error while sending messages to the service.
Generated using TypeDoc
A Sender can be used to send messages, schedule messages to be sent at a later time and cancel such scheduled messages. Use the
createSender
function on the ServiceBusClient to instantiate a Sender. The Sender class is an abstraction over the underlying AMQP sender link.