SubscribeOptions
API reference for SubscribeOptions
Interface: SubscribeOptions
Section titled “Interface: SubscribeOptions”Options for creating a subscription
Properties
Section titled “Properties”eventFilter
Section titled “eventFilter”eventFilter:
EventFilterPattern
Pattern(s) determining which events to receive
initialPosition?
Section titled “initialPosition?”
optionalinitialPosition:InitialPosition
The position in the message stream from which a consumer starts consuming messages when there is no prior checkpoint. Defaults to latest.
subscriber
Section titled “subscriber”subscriber:
SubscriberConfig
Configuration for the subscriber that will receive events
subscriberId?
Section titled “subscriberId?”
optionalsubscriberId:string
Optional custom ID for this subscription. If not provided, one will be generated.