Package version:

Interface ChangeFeedOptions

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:

If none of those options are set, it will start reading changes from the first ChangeFeedIterator.fetchNext() call.

interface ChangeFeedOptions {
    continuation?: string;
    maxItemCount?: number;
    sessionToken?: string;
    startFromBeginning?: boolean;
    startTime?: Date;
}

Properties

continuation?: string

The continuation token to start from.

This is equivalent to the etag and continuation value from the ChangeFeedResponse

maxItemCount?: number

Max amount of items to return per page

sessionToken?: string

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

startFromBeginning?: boolean

Signals whether to start from the beginning or not.

startTime?: Date

Specified the start time to start reading changes from.