Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FeedOptions

The feed options and query methods.

Hierarchy

Index

Properties

Properties

Optional abortSignal

abortSignal: AbortSignal

abortSignal to pass to all underlying network requests created by this method call. See https://developer.mozilla.org/en-US/docs/Web/API/AbortController

example

Cancel a read request

const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()

Optional accessCondition

accessCondition: object

Conditions Associated with the request.

Type declaration

  • condition: string

    Conditional HTTP method header value (the _etag field from the last version you read).

  • type: string

    Conditional HTTP method header type (IfMatch or IfNoneMatch).

Optional continuation

continuation: string

Opaque token for continuing the enumeration.

Optional enableScanInQuery

enableScanInQuery: boolean

Allow scan on the queries which couldn't be served as indexing was opted out on the requested paths.

Optional initialHeaders

initialHeaders: CosmosHeaders

(Advanced use case) Initial headers to start with when sending requests to Cosmos

Optional maxDegreeOfParallelism

maxDegreeOfParallelism: number

The maximum number of concurrent operations that run client side during parallel query execution in the Azure Cosmos DB database service. Negative values make the system automatically decides the number of concurrent operations to run.

Optional maxItemCount

maxItemCount: number

Max number of items to be returned in the enumeration operation.

Optional populateQueryMetrics

populateQueryMetrics: boolean

Enable returning query metrics in response headers

Optional sessionToken

sessionToken: string

Enables/disables getting document container quota related stats for document container read requests.

Optional useIncrementalFeed

useIncrementalFeed: boolean

Indicates a change feed request. Must be set to "Incremental feed", or omitted otherwise.

Generated using TypeDoc