Interface Subscription

Package version

Interface that describes the object returned by the subscribe() method on the EventHubConsumerClient.

Hierarchy

Subscription

Index

Properties

isRunning

Methods

close

Properties

isRunning

isRunning: boolean

Indicates whether the receiver is running. true - is running; false otherwise.

readonly

Methods

close

close(): Promise<void>

- Defined in eventHubConsumerClientModels.ts:216
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.

throws

Error if the underlying connection encounters an error while closing.

Returns Promise<void>

Promise

Generated using TypeDoc