Skip to main content

ISummaryBaseConfiguration Interface

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 ISummaryBaseConfiguration

Properties​

Property Alerts Type Description
initialSummarizerDelayMs Alpha number Delay before first attempt to spawn summarizing container.
maxAckWaitTime Alpha number Defines the maximum allowed time to wait for a pending summary ack. The maximum amount of time client will wait for a summarize is the minimum of maxSummarizeAckWaitTime (currently 3 * 60 * 1000) and maxAckWaitTime.
maxOpsSinceLastSummary Alpha number Defines the maximum number of Ops in between Summaries that can be allowed before forcibly electing a new summarizer client.

Property Details​

initialSummarizerDelayMs​

Delay before first attempt to spawn summarizing container.

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

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

Signature​

initialSummarizerDelayMs: number;

Type: number

maxAckWaitTime​

Defines the maximum allowed time to wait for a pending summary ack. The maximum amount of time client will wait for a summarize is the minimum of maxSummarizeAckWaitTime (currently 3 * 60 * 1000) and maxAckWaitTime.

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

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

Signature​

maxAckWaitTime: number;

Type: number

maxOpsSinceLastSummary​

Defines the maximum number of Ops in between Summaries that can be allowed before forcibly electing a new summarizer client.

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

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

Signature​

maxOpsSinceLastSummary: number;

Type: number