Summarizer Class

Packages > @fluidframework/container-runtime > Summarizer

Summarizer is responsible for coordinating when to generate and send summaries. It is the main entry point for summary work. It is created only by summarizing container (i.e. one with clientType === “summarizer”)

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 declare class Summarizer extends TypedEventEmitter<ISummarizerEvents> implements ISummarizer

Extends: TypedEventEmitter <ISummarizerEvents >

Implements: ISummarizer

Constructors

Constructor Alerts Description
(constructor)(runtime, configurationGetter, internalsProvider, handleContext, summaryCollection, runCoordinatorCreateFn) Alpha Constructs a new instance of the Summarizer class

Properties

Property Alerts Modifiers Type Description
ISummarizer Alpha readonly this
summaryCollection Alpha readonly SummaryCollection

Constructor Details

(constructor)

Constructs a new instance of the Summarizer class

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 

constructor(
    runtime: ISummarizerRuntime, configurationGetter: () => ISummaryConfiguration, 
    internalsProvider: ISummarizerInternalsProvider, handleContext: IFluidHandleContext, summaryCollection: SummaryCollection, runCoordinatorCreateFn: (runtime: IConnectableRuntime) => Promise<ICancellableSummarizerController>);

Parameters

Parameter Type Description
runtime ISummarizerRuntime
configurationGetter () => ISummaryConfiguration
internalsProvider ISummarizerInternalsProvider
handleContext IFluidHandleContext
summaryCollection SummaryCollection
runCoordinatorCreateFn (runtime: IConnectableRuntime) => Promise<ICancellableSummarizerController>

Property Details

ISummarizer

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 

get ISummarizer(): this;

Type: this

summaryCollection

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 summaryCollection: SummaryCollection;

Type: SummaryCollection