ISummaryRuntimeOptions Interface

Signature

export interface ISummaryRuntimeOptions

Properties

Property	Alerts	Modifiers	Type	Description
disableIsolatedChannels		optional	boolean
disableSummaries	Deprecated	optional	boolean
initialSummarizerDelayMs	Deprecated	optional	number
maxOpsSinceLastSummary	Deprecated	optional	number
summarizerClientElection	Deprecated	optional	boolean
summarizerOptions	Deprecated	optional	Readonly<Partial<ISummarizerOptions>>
summaryConfigOverrides		optional	ISummaryConfiguration	Override summary configurations set by the server.

Property Details

disableIsolatedChannels

Signature

disableIsolatedChannels?: boolean;

Type: boolean

disableSummaries

This API is deprecated and will be removed in a future release.

• use summaryConfigOverrides.disableSummaries instead. Flag that disables summaries if it is set to true.

Signature

disableSummaries?: boolean;

Type: boolean

initialSummarizerDelayMs

This API is deprecated and will be removed in a future release.

• use summaryConfigOverrides.initialSummarizerDelayMs instead. Delay before first attempt to spawn summarizing container.

Signature

initialSummarizerDelayMs?: number;

Type: number

maxOpsSinceLastSummary

This API is deprecated and will be removed in a future release.

• use summaryConfigOverrides.maxOpsSinceLastSummary instead. Defaults to 7000 ops

Signature

maxOpsSinceLastSummary?: number;

Type: number

summarizerClientElection

This API is deprecated and will be removed in a future release.

• use summaryConfigOverrides.summarizerClientElection instead. Flag that will enable changing elected summarizer client after maxOpsSinceLastSummary. This defaults to false (disabled) and must be explicitly set to true to enable.

Signature

summarizerClientElection?: boolean;

Type: boolean

summarizerOptions

This API is deprecated and will be removed in a future release.

• use summaryConfigOverrides.state = "DisableHeuristics" instead. Options that control the running summarizer behavior.

Signature

summarizerOptions?: Readonly<Partial<ISummarizerOptions>>;

Type: Readonly<Partial<ISummarizerOptions>>

summaryConfigOverrides

Override summary configurations set by the server.

Signature

summaryConfigOverrides?: ISummaryConfiguration;

Type: ISummaryConfiguration