Skip to main content

IEnqueueSummarizeOptions Interface

Options to use when enqueueing a summarize attempt.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

For more information about our API support guarantees, see here.

Signature​

export interface IEnqueueSummarizeOptions extends IOnDemandSummarizeOptions

Extends: IOnDemandSummarizeOptions

Properties​

Property Alerts Modifiers Type Description
afterSequenceNumber Alpha optional, readonly number If specified, The summarize attempt will not occur until after this sequence number.
override Alpha optional, readonly 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.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

For more information about our API support guarantees, see here.

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.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/container-runtime/alpha.

For more information about our API support guarantees, see here.

Signature​

readonly override?: boolean;

Type: boolean