ChangeFeedOptions interface
Specifies options for the change feed
Some of these options control where and when to start reading from the change feed. The order of precedence is:
- continuation
- startTime
- startFromBeginning
If none of those options are set, it will start reading changes from the first ChangeFeedIterator.fetchNext()
call.
Properties
continuation | The continuation token to start from. This is equivalent to the etag and continuation value from the |
max |
Max amount of items to return per page |
session |
The session token to use. If not specified, will use the most recent captured session token to start with. |
start |
Signals whether to start from the beginning or not. |
start |
Specified the start time to start reading changes from. |
Property Details
continuation
The continuation token to start from.
This is equivalent to the etag and continuation value from the ChangeFeedResponse
continuation?: string
Property Value
string
maxItemCount
Max amount of items to return per page
maxItemCount?: number
Property Value
number
sessionToken
The session token to use. If not specified, will use the most recent captured session token to start with.
sessionToken?: string
Property Value
string
startFromBeginning
Signals whether to start from the beginning or not.
startFromBeginning?: boolean
Property Value
boolean
startTime
Specified the start time to start reading changes from.
startTime?: Date
Property Value
Date