@azure/service-bus

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AuthorizationRule

AuthorizationRule: { claimType: string; claimValue: string; keyName: string; primaryKey?: undefined | string; rights: { accessRights?: string[] }; secondaryKey?: undefined | string }

Represents type of AuthorizationRule in ATOM based management operations.

Type declaration

claimType: string
claimValue: string
keyName: string
Optional primaryKey?: undefined | string
rights: { accessRights?: string[] }
- Optional accessRights?: string[]
Optional secondaryKey?: undefined | string

EntityStatus

Possible values for status of the Service Bus messaging entities.

MessageCountDetails

MessageCountDetails: { activeMessageCount: number; deadLetterMessageCount: number; scheduledMessageCount: number; transferDeadLetterMessageCount: number; transferMessageCount: number }

Represents type of message count details in ATOM based management operations.

Type declaration

activeMessageCount: number
deadLetterMessageCount: number
scheduledMessageCount: number
transferDeadLetterMessageCount: number
transferMessageCount: number

MessageSessionOptions

MessageSessionOptions: SessionManagerOptions & SessionReceiverOptions & { callee?: SessionCallee; receiveMode?: ReceiveMode }

internal: Describes all the options that can be set while instantiating a MessageSession object.

OperationOptionsBase

OperationOptionsBase: Pick<OperationOptions, "abortSignal" | "tracingOptions">

Options for configuring tracing and the abortSignal.

SqlParameter

SqlParameter: { key: string; type: string; value: string | number }

Represents type of SQL Parameter in ATOM based management operations

Type declaration

key: string
type: string
value: string | number

SqlRuleAction

SqlRuleAction: SqlRuleFilter

Represents all possible fields on SqlAction

Variables

Const batching

batching: any = debugModule("azure:service-bus:receiverbatching")

internal: log statements for receiverbatching

Const connectionCtxt

connectionCtxt: any = debugModule("azure:service-bus:connectionContext")

internal: log statements for connectionContext

Const entityCtxt

entityCtxt: any = debugModule("azure:service-bus:clientEntityContext")

internal: log statements for clientEntityContext

Const error

error: any = debugModule("azure:service-bus:error")

internal: log statements for error

Const httpAtomXml

httpAtomXml: any = debugModule("azure:service-bus:atom-xml")

internal: log statements for Atom XML management API over HTTP

Const largeMessageOverhead

largeMessageOverhead: 8 = 8

The amount of bytes to reserve as overhead for a large message.

Const link

link: any = debugModule("azure:service-bus:linkEntity")

internal: log statements for linkEntity

Const map

map: any = debugModule("azure:service-bus:concurrentMap")

internal: log statements for map

Const message

message: any = debugModule("azure:service-bus:servicebusMessage")

internal: log statements for servicebusMessage

Const messageSession

messageSession: any = debugModule("azure:service-bus:messageSession")

internal: log statements for messageSession

Const mgmt

mgmt: any = debugModule("azure:service-bus:management")

internal: log statements for management

Const ns

ns: any = debugModule("azure:service-bus:namespace")

internal: log statements for namespace

Const receiver

receiver: any = debugModule("azure:service-bus:receiver")

internal: log statements for receiver

Const semaphore

semaphore: any = debugModule("azure:service-bus:semaphore")

internal: log statements for semaphore

Const sender

sender: any = debugModule("azure:service-bus:sender")

internal: log statements for sender

Const sessionManager

sessionManager: any = debugModule("azure:service-bus:sessionManager")

internal: log statements for sessionManager

Const smallMessageMaxBytes

smallMessageMaxBytes: 255 = 255

The maximum number of bytes that a message may be to be considered small.

Const smallMessageOverhead

smallMessageOverhead: 5 = 5

The amount of bytes to reserve as overhead for a small message.

Const streaming

streaming: any = debugModule("azure:service-bus:receiverstreaming")

internal: log statements for receiverstreaming

Const utils

utils: any = debugModule("azure:service-bus:utils")

internal: log statements for utils

Const warning

warning: any = debugModule("azure:service-bus:warning")

internal: log statements for warning

Functions

getAlreadyReceivingErrorMsg

getAlreadyReceivingErrorMsg(entityPath: string, sessionId?: undefined | string): string

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/errors.ts:102
internal

Parameters
- entityPath: string
  
  Value of the entityPath property on the client which denotes its name
- Optional sessionId: undefined | string
  
  If using session receiver, then the id of the session
Returns string

getClientClosedErrorMsg

getClientClosedErrorMsg(entityPath: string): string

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/errors.ts:48
internal

Gets the error message when a client is used when its already closed

Parameters
- entityPath: string
  
  Value of the entityPath property on the client which denotes its name
Returns string

getErrorMessageNotSupportedInReceiveAndDeleteMode

getErrorMessageNotSupportedInReceiveAndDeleteMode(failedToDo: string): string

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/errors.ts:220
internal

Gets error message for when an operation is not supported in ReceiveAndDelete mode

Parameters
- failedToDo: string
  
  A string to add to the placeholder in the error message. Denotes the action that is not supported in ReceiveAndDelete mode
Returns string

getMessagePropertyTypeMismatchError

getMessagePropertyTypeMismatchError(msg: ServiceBusMessage): Error | undefined

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusMessage.ts:229
internal

Gets the error message for when a property on given message is not of expected type

Parameters
- msg: ServiceBusMessage
Returns Error | undefined

getReceiverClosedErrorMsg

getReceiverClosedErrorMsg(entityPath: string, isClientClosed: boolean, sessionId?: undefined | string): string

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/errors.ts:74
internal

Gets the error message when a receiver is used when its already closed

Parameters
- entityPath: string
  
  Value of the entityPath property on the client which denotes its name
- isClientClosed: boolean
  
  Denotes if the close() was called on the client that created the sender
- Optional sessionId: undefined | string
  
  If using session receiver, then the id of the session
Returns string

getSenderClosedErrorMsg

getSenderClosedErrorMsg(entityPath: string): string

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/errors.ts:60
internal

Gets the error message when a sender is used when its already closed

Parameters
- entityPath: string
  
  Value of the entityPath property on the client which denotes its name
Returns string

throwErrorIfClientOrConnectionClosed

throwErrorIfClientOrConnectionClosed(context: ConnectionContext, entityPath: string, isClientClosed: boolean): void

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/errors.ts:29
internal

Logs and throws error if the underlying AMQP connection or if the client is closed

Parameters
- context: ConnectionContext
  
  The ConnectionContext associated with the current AMQP connection.
- entityPath: string
  
  Entity Path of the client which denotes the name of the Queue/Topic/Subscription
- isClientClosed: boolean
  
  Boolean denoting if the client is closed or not
Returns void

throwErrorIfConnectionClosed

throwErrorIfConnectionClosed(context: ConnectionContext): void

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/errors.ts:13
internal

Logs and throws Error if the current AMQP connection is closed.

Parameters
- context: ConnectionContext
  
  The ConnectionContext associated with the current AMQP connection.
Returns void

throwTypeErrorIfParameterIsEmptyString

throwTypeErrorIfParameterIsEmptyString(connectionId: string, parameterName: string, parameterValue: string): TypeError | undefined

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/errors.ts:201
internal

Logs and Throws TypeError if given parameter is an empty string

Parameters
- connectionId: string
  
  Id of the underlying AMQP connection used for logging
- parameterName: string
  
  Name of the parameter to type check
- parameterValue: string
  
  Value of the parameter to type check
Returns TypeError | undefined

throwTypeErrorIfParameterMissing

throwTypeErrorIfParameterMissing(connectionId: string, parameterName: string, parameterValue: any): void

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/errors.ts:116
internal

Logs and Throws TypeError if given parameter is undefined or null

Parameters
- connectionId: string
  
  Id of the underlying AMQP connection used for logging
- parameterName: string
  
  Name of the parameter to check
- parameterValue: any
  
  Value of the parameter to check
Returns void

throwTypeErrorIfParameterNotLong

throwTypeErrorIfParameterNotLong(connectionId: string, parameterName: string, parameterValue: any): TypeError | undefined

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/errors.ts:158
internal

Logs and Throws TypeError if given parameter is not of type Long or an array of type Long

Parameters
- connectionId: string
  
  Id of the underlying AMQP connection used for logging
- parameterName: string
  
  Name of the parameter to type check
- parameterValue: any
  
  Value of the parameter to type check
Returns TypeError | undefined

throwTypeErrorIfParameterNotLongArray

throwTypeErrorIfParameterNotLongArray(connectionId: string, parameterName: string, parameterValue: any[]): TypeError | undefined

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/errors.ts:181
internal

Logs and Throws TypeError if given parameter is not an array of type Long

Parameters
- connectionId: string
  
  Id of the underlying AMQP connection used for logging
- parameterName: string
  
  Name of the parameter to type check
- parameterValue: any[]
  
  Value of the parameter to type check
Returns TypeError | undefined

throwTypeErrorIfParameterTypeMismatch

throwTypeErrorIfParameterTypeMismatch(connectionId: string, parameterName: string, parameterValue: any, expectedType: string): void

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/util/errors.ts:136
internal

Logs and Throws TypeError if given parameter is not of expected type

Parameters
- connectionId: string
  
  Id of the underlying AMQP connection used for logging
- parameterName: string
  
  Name of the parameter to type check
- parameterValue: any
  
  Value of the parameter to type check
- expectedType: string
  
  Expected type of the parameter
Returns void

toAmqpMessage

toAmqpMessage(msg: ServiceBusMessage): AmqpMessage

- Defined in home/vsts/work/1/s/sdk/servicebus/service-bus/src/serviceBusMessage.ts:286
internal

Converts given ServiceBusMessage to AmqpMessage

Parameters
- msg: ServiceBusMessage
Returns AmqpMessage

Index

Modules

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AuthorizationRule

Type declaration

claimType: string

claimValue: string

keyName: string

Optional primaryKey?: undefined | string

rights: { accessRights?: string[] }

Optional accessRights?: string[]

Optional secondaryKey?: undefined | string

EntityStatus

MessageCountDetails

Type declaration

activeMessageCount: number

deadLetterMessageCount: number

scheduledMessageCount: number

transferDeadLetterMessageCount: number

transferMessageCount: number

MessageSessionOptions

OperationOptionsBase

SqlParameter

Type declaration

key: string

type: string

value: string | number

SqlRuleAction

Variables

Const batching

Const connectionCtxt

Const entityCtxt

Const error

Const httpAtomXml

Const largeMessageOverhead

Const link

Const map

Const message

Const messageSession

Const mgmt

Const ns

Const receiver

Const semaphore

Const sender

Const sessionManager

Const smallMessageMaxBytes

Const smallMessageOverhead

Const streaming

Const utils

Const warning

Functions

getAlreadyReceivingErrorMsg

Parameters

entityPath: string

Optional sessionId: undefined | string

Returns string

getClientClosedErrorMsg

Parameters

entityPath: string

Returns string

getErrorMessageNotSupportedInReceiveAndDeleteMode

Parameters

failedToDo: string

Returns string

getMessagePropertyTypeMismatchError

Parameters

msg: ServiceBusMessage

Returns Error | undefined

getReceiverClosedErrorMsg

Parameters

entityPath: string

isClientClosed: boolean

Optional sessionId: undefined | string

Returns string