SharedOptions | @azure/cosmos

Options that can be specified for a requested issued to the Azure Cosmos DB servers.=

Hierarchy

SharedOptions
- FeedOptions
- RequestOptions

Index

Properties

abortSignal
initialHeaders
sessionToken

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 initialHeaders

initialHeaders: CosmosHeaders

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

Optional sessionToken

sessionToken: string

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