Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventHubClientOptions

Package version

Describes the options that can be provided while creating the EventHubClient.

  • userAgent : A string to append to the built in user agent string that is passed as a connection property to the service.
  • webSocketOptions : Options to configure the channelling of the AMQP connection over Web Sockets.
    • websocket : The WebSocket constructor used to create an AMQP connection if you choose to make the connection over a WebSocket.
    • webSocketConstructorOptions : Options to pass to the Websocket constructor when you choose to make the connection over a WebSocket.
  • retryOptions : The retry options for all the operations on the client/producer/consumer. A simple usage can be { "maxRetries": 4 }.

Example usage:

{
    retryOptions: {
        maxRetries: 4
    }
}

Hierarchy

Index

Properties

Optional retryOptions

retryOptions: RetryOptions
property

Options to configure the retry policy for all the operations on the client. For example, { "maxRetries": 4 } or { "maxRetries": 4, "retryDelayInMs": 30000 }.

Optional userAgent

userAgent: undefined | string
property

Value that is appended to the built in user agent string that is passed to the Event Hubs service.

Optional webSocketOptions

webSocketOptions: WebSocketOptions
property

Options to configure the channelling of the AMQP connection over Web Sockets.

Generated using TypeDoc