UNPKG

1.08 kBTypeScriptView Raw
1/**
2 * Specifies options for the change feed
3 *
4 * Some of these options control where and when to start reading from the change feed. The order of precedence is:
5 * - continuation
6 * - startTime
7 * - startFromBeginning
8 *
9 * If none of those options are set, it will start reading changes from the first `ChangeFeedIterator.fetchNext()` call.
10 */
11export interface ChangeFeedOptions {
12 /**
13 * Max amount of items to return per page
14 */
15 maxItemCount?: number;
16 /**
17 * The continuation token to start from.
18 *
19 * This is equivalent to the etag and continuation value from the `ChangeFeedResponse`
20 */
21 continuation?: string;
22 /**
23 * The session token to use. If not specified, will use the most recent captured session token to start with.
24 */
25 sessionToken?: string;
26 /**
27 * Signals whether to start from the beginning or not.
28 */
29 startFromBeginning?: boolean;
30 /**
31 * Specified the start time to start reading changes from.
32 */
33 startTime?: Date;
34}
35//# sourceMappingURL=ChangeFeedOptions.d.ts.map
\No newline at end of file