UNPKG

1.75 kBTypeScriptView Raw
1import { CosmosHeaders } from "./queryExecutionContext";
2/**
3 * A single response page from the Azure Cosmos DB Change Feed
4 */
5export declare class ChangeFeedResponse<T> {
6 /**
7 * Gets the items returned in the response from Azure Cosmos DB
8 */
9 readonly result: T;
10 /**
11 * Gets the number of items returned in the response from Azure Cosmos DB
12 */
13 readonly count: number;
14 /**
15 * Gets the status code of the response from Azure Cosmos DB
16 */
17 readonly statusCode: number;
18 /**
19 * Gets the request charge for this request from the Azure Cosmos DB service.
20 */
21 get requestCharge(): number;
22 /**
23 * Gets the activity ID for the request from the Azure Cosmos DB service.
24 */
25 get activityId(): string;
26 /**
27 * Gets the continuation token to be used for continuing enumeration of the Azure Cosmos DB service.
28 *
29 * This is equivalent to the `etag` property.
30 */
31 get continuation(): string;
32 /**
33 * Gets the session token for use in session consistency reads from the Azure Cosmos DB service.
34 */
35 get sessionToken(): string;
36 /**
37 * Gets the entity tag associated with last transaction in the Azure Cosmos DB service,
38 * which can be used as If-Non-Match Access condition for ReadFeed REST request or
39 * `continuation` property of `ChangeFeedOptions` parameter for
40 * `Items.changeFeed()`
41 * to get feed changes since the transaction specified by this entity tag.
42 *
43 * This is equivalent to the `continuation` property.
44 */
45 get etag(): string;
46 /**
47 * Response headers of the response from Azure Cosmos DB
48 */
49 headers: CosmosHeaders;
50}
51//# sourceMappingURL=ChangeFeedResponse.d.ts.map
\No newline at end of file