Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventDataBatch

Package version

An interface representing a batch of events which can be used to send events to Event Hub.

To create the batch, use the createBatch() method on the EventHubProducerClient. To send the batch, use the sendBatch() method on the same client. To fill the batch, use the tryAdd() method on the batch itself.

Hierarchy

  • EventDataBatch

Index

Properties

Methods

Properties

count

count: number

Number of events added to the batch.

readonly

maxSizeInBytes

maxSizeInBytes: number

The maximum size of the batch, in bytes. The tryAdd function on the batch will return false if the event being added causes the size of the batch to exceed this limit. Use the createBatch() method on the EventHubProducerClient 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.

readonly

Methods

tryAdd

  • Adds an event 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

    Returns boolean

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

Generated using TypeDoc