ChangeFeedStartFrom class

Package:

@azure/cosmos

Base class for where to start a ChangeFeedIterator.

Methods

Beginning(PartitionKey | FeedRange)	Returns an object that tells the ChangeFeedIterator to start from the beginning of time.
Continuation(string)	Returns an object that tells the ChangeFeedIterator to start reading changes from a save point.
Now(PartitionKey | FeedRange)	Returns an object that tells the ChangeFeedIterator to start reading changes from this moment onward.
Time(Date, PartitionKey | FeedRange)	Returns an object that tells the ChangeFeedIterator to start reading changes from some point in time onward.

Method Details

Beginning(PartitionKey | FeedRange)

Returns an object that tells the ChangeFeedIterator to start from the beginning of time.

static function Beginning(cfResource?: PartitionKey | FeedRange): ChangeFeedStartFromBeginning

Parameters

cfResource

PartitionKey | FeedRange

PartitionKey or FeedRange for which changes are to be fetched. Leave blank for fetching changes for entire container.

Returns

ChangeFeedStartFromBeginning

Continuation(string)

Returns an object that tells the ChangeFeedIterator to start reading changes from a save point.

static function Continuation(continuationToken: string): ChangeFeedStartFromContinuation

Parameters

continuationToken

string

Returns

ChangeFeedStartFromContinuation

Now(PartitionKey | FeedRange)

Returns an object that tells the ChangeFeedIterator to start reading changes from this moment onward.

static function Now(cfResource?: PartitionKey | FeedRange): ChangeFeedStartFromNow

Parameters

cfResource

PartitionKey | FeedRange

PartitionKey or FeedRange for which changes are to be fetched. Leave blank for fetching changes for entire container.

Returns

ChangeFeedStartFromNow

Time(Date, PartitionKey | FeedRange)

Returns an object that tells the ChangeFeedIterator to start reading changes from some point in time onward.

static function Time(startTime: Date, cfResource?: PartitionKey | FeedRange): ChangeFeedStartFromTime

Parameters

startTime

Date

Date object specfiying the time to start reading changes from.

cfResource

PartitionKey | FeedRange

PartitionKey or FeedRange for which changes are to be fetched. Leave blank for fetching changes for entire container.

Returns

ChangeFeedStartFromTime