ChangeFeedIteratorOptions interface

Specifies options for the change feed

If none of those options are set, it will start reading changes from now for the entire container.

Properties

changeFeedMode

Signals the mode in which the change feed needs to start.

changeFeedStartFrom

Signals where to start from in the change feed.

maxItemCount

Max amount of items to return per page

sessionToken

The session token to use. If not specified, will use the most recent captured session token to start with.

Property Details

changeFeedMode

Signals the mode in which the change feed needs to start.

changeFeedMode?: ChangeFeedMode

Property Value

changeFeedStartFrom

Signals where to start from in the change feed.

changeFeedStartFrom?: ChangeFeedStartFrom

Property Value

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