Package version:

Interface ServiceBusMessageBatch

A batch of messages that you can create using the createBatch method.

interface ServiceBusMessageBatch {
    count: number;
    maxSizeInBytes: number;
    sizeInBytes: number;
    tryAddMessage(message, options?): boolean;
}

Properties

count maxSizeInBytes sizeInBytes

Methods

tryAddMessage

Properties

Readonly count

count: number

Number of messages added to the batch.

Readonly maxSizeInBytes

maxSizeInBytes: number

The maximum size of the batch, in bytes. The tryAddMessage function on the batch will return false if the message being added causes the size of the batch to exceed this limit. Use the createMessageBatch() method on the Sender to set the maxSizeInBytes.

Readonly sizeInBytes

sizeInBytes: number

Size of the batch in bytes after the events added to it have been encoded into a single AMQP message.

Methods

tryAddMessage

  • tryAddMessage(message, options?): boolean

  • Adds a message to the batch if permitted by the batch's size limit. NOTE: Always remember to check the return value of this method, before calling it again for the next event.

    Parameters

    • message: any

      The message to add to the batch.

    • Optional options: TryAddOptions

    Returns boolean

    A boolean value indicating if the message has been added to the batch or not.

Settings

Member Visibility

Theme

Generated using TypeDoc