Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ConnectionConfig

Package version

Describes the connection config object that is created after parsing an EventHub or ServiceBus connection string.

Hierarchy

  • ConnectionConfig

Index

Properties

Properties

connectionString

connectionString: string
property

{string} connectionString - The connection string.

endpoint

endpoint: string
property

{string} endpoint - The service bus endpoint "sb://.servicebus.windows.net/".

Optional entityPath

entityPath: undefined | string
property

{string} entityPath - The name/path of the entity (hub/queue/topic name) to which the connection needs to happen.

host

host: string
property

{string} host - The host ".servicebus.windows.net".

sharedAccessKey

sharedAccessKey: string
property

{string} sharedAccessKey - The secret value of the access key.

sharedAccessKeyName

sharedAccessKeyName: string
property

{string} sharedAccessKeyName - The name of the access key.

Optional webSocket

webSocket: WebSocketImpl
property

{WebSocketImpl} [webSocket] - The WebSocket constructor used to create an AMQP connection over a WebSocket. In browsers, the built-in WebSocket will be used by default. In Node, a TCP socket will be used if a WebSocket constructor is not provided.

Optional webSocketConstructorOptions

webSocketConstructorOptions: any
property

{any} [webSocketConstructorOptions] - Options to be passed to the WebSocket constructor

Optional webSocketEndpointPath

webSocketEndpointPath: undefined | string
property

{string} [webSocketEndpointPath] - The path for the endpoint that accepts an AMQP connection over WebSockets.

Generated using TypeDoc