IEnqueueSummarizeOptions Interface
Options to use when enqueueing a summarize attempt.
Signature
export interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions
Extends: IOnDemandSummarizeOptions
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| afterSequenceNumber | optional | number | If specified, The summarize attempt will not occur until after this sequence number. |
| override | optional | boolean | True to override the existing enqueued summarize attempt if there is one. This will guarantee that this attempt gets enqueued. If override is false, than an existing enqueued summarize attempt will block a new one from being enqueued. There can only be one enqueued at a time. Defaults to false. |
Property Details
afterSequenceNumber
If specified, The summarize attempt will not occur until after this sequence number.
Signature
readonly afterSequenceNumber?: number;
Type: number
override
True to override the existing enqueued summarize attempt if there is one. This will guarantee that this attempt gets enqueued. If override is false, than an existing enqueued summarize attempt will block a new one from being enqueued. There can only be one enqueued at a time. Defaults to false.
Signature
readonly override?: boolean;
Type: boolean