ChangeFeedIterator class

Package:

@azure/cosmos

Provides iterator for change feed.

Use Items.changeFeed() to get an instance of the iterator.

Properties

hasMoreResults

Gets a value indicating whether there are potentially additional results that can be retrieved. Initially returns true. This value is set based on whether the last execution returned a continuation token.

Methods

fetchNext()	Read feed and retrieves the next page of results in Azure Cosmos DB.
getAsyncIterator()	Gets an async iterator which will yield pages of results from Azure Cosmos DB.

Property Details

hasMoreResults

Gets a value indicating whether there are potentially additional results that can be retrieved.

Initially returns true. This value is set based on whether the last execution returned a continuation token.

boolean hasMoreResults

Property Value

boolean

Boolean value representing if whether there are potentially additional results that can be retrieved.

Method Details

fetchNext()

Read feed and retrieves the next page of results in Azure Cosmos DB.

function fetchNext(): Promise<ChangeFeedResponse<(T & Resource)[]>>

Returns

Promise<ChangeFeedResponse<(T & Resource)[]>>

getAsyncIterator()

Gets an async iterator which will yield pages of results from Azure Cosmos DB.

function getAsyncIterator(): AsyncIterable<ChangeFeedResponse<(T & Resource)[]>>

Returns

AsyncIterable<ChangeFeedResponse<(T & Resource)[]>>