Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SubscribeOptions

Package version

Options used when subscribing to a Service Bus queue or subscription.

Hierarchy

Index

Properties

Optional autoComplete

autoComplete: undefined | false | true
property

Indicates whether the complete() method on the message should automatically be called by the sdk after the user provided onMessage handler has been executed. Calling complete() on a message removes it from the Queue/Subscription.

  • Default: true.

Optional maxAutoRenewLockDurationInMs

maxAutoRenewLockDurationInMs: undefined | number
property

The maximum duration in milliseconds until which the lock on the message will be renewed by the sdk automatically. This auto renewal stops once the message is settled or once the user provided onMessage handler completes ite execution.

  • Default: 300 * 1000 milliseconds (5 minutes).
  • To disable autolock renewal, set this to 0.

Optional maxConcurrentCalls

maxConcurrentCalls: undefined | number
property

The maximum number of concurrent calls that the library can make to the user's message handler. Once this limit has been reached, more messages will not be received until atleast one of the calls to the user's message handler has completed.

  • Default: 1.

Generated using TypeDoc