Package version
Defines an object with possible properties defined in T.
A constant that indicates whether the environment is node.js or browser based.
The @azure/logger configuration for this package.
This will output logs using the azure:event-hubs namespace prefix.
Provides a list of retryable AMQP errors. "InternalServerError", "ServerBusyError", "ServiceUnavailableError", "OperationCancelledError", "SenderBusyError", "MessagingError", "DetachForcedError", "ConnectionForcedError", "TransferLimitExceededError"
A wrapper for setTimeout that resolves a promise after t milliseconds.
The number of milliseconds to be delayed.
The abortSignal associated with containing operation.
The abort error message associated with containing operation.
The value to be resolved with after a timeout of t milliseconds.
Gets a new instance of the async lock with desired settings.
AsyncLock
object that may contain error information
Determines whether the given connection string is an iothub connection string.
The connection string.
boolean.
Checks whether the provided error is a node.js SystemError.
An object that may contain error information.
Parses the connection string and returns an object of type T.
Connection strings have the following syntax:
ConnectionString ::= Part { ";" Part } [ ";" ] [ WhiteSpace ] Part ::= [ PartLiteral [ "=" PartLiteral ] ] PartLiteral ::= [ WhiteSpace ] Literal [ WhiteSpace ] Literal ::= ? any sequence of characters except ; or = or WhiteSpace ? WhiteSpace ::= ? all whitespace characters including \r and \n ?
The connection string to be parsed.
ParsedOutput
Generates a random number between the given interval
Min number of the range (inclusive).
Max number of the range (inclusive).
Every operation is attempted at least once. Additional attempts are made if the previous attempt failed
with a retryable error. The number of additional attempts is governed by the maxRetries property provided
on the RetryConfig argument.
If mode option is set to Fixed, then the retries are made on the
given operation for a specified number of times, with a fixed delay in between each retry each time.
If mode option is set to Exponential, then the delay between retries is adjusted to increase
exponentially with each attempt using back-off factor of power 2.
Parameters to configure retry operation
Promise
Translates the AMQP error received at the protocol layer or a SystemError into a MessagingError. All other errors are returned unaltered.
The amqp error that was received.
MessagingError object.
Describes the ConnectionConfig module
Creates the connection config.
The connection string for a given service like EventHub/ServiceBus.
ConnectionConfig
Validates the properties of connection config.
The connection config to be validated.
void
Creates the base connection context.
Parameters to be provided to create the base connection context.
Describes the connection config object that is created after parsing an EventHub connection string. It also provides some convenience methods for getting the address and audience for different entities.
Creates the connection config.
The connection string for a given service like EventHub/ServiceBus.
EventHubConnectionConfig
Creates an EventHubConnectionConfig from the provided base ConnectionConfig.
The base connection config from which the EventHubConnectionConfig needs to be created.
EventHubConnectionConfig
Validates the properties of connection config.
The connection config to be validated.
void
Describes the operations that can be performed on the message header.
Converts AmqpMessageHeader to MessageHeader.
Amqp Message Header
MessageHeader.
Converts MessageHeader to AmqpMessageHeader.
Message header.
AmqpMessageHeader
Describes the operations that can be performed on the amqp message properties.
Converts AmqpMessageProperties to MessageProperties.
Amqp message properties.
MessageProperties.
Converts MessageProperties to AmqpMessageProperties.
Message properties.
AmqpMessageProperties.
Generated using TypeDoc
Type declaration for a Function type where T is the input to the function and V is the output of the function.