Subscription interface
Interface that describes the object returned by the subscribe()
method on the EventHubConsumerClient
.
Properties
is |
Indicates whether the receiver is running.
|
Methods
close() | Stops the subscription from receiving more messages. If a checkpoint store has been configured this will also mark this subscription's partitions as abandoned, freeing them up to be read by other consumers. |
Property Details
isRunning
Indicates whether the receiver is running.
true
- is running; false
otherwise.
isRunning: boolean
Property Value
boolean
Method Details
close()
Stops the subscription from receiving more messages.
If a checkpoint store has been configured this will also mark this subscription's partitions as abandoned, freeing them up to be read by other consumers.
function close(): Promise<void>
Returns
Promise<void>
Promise