Summarizer Class

Packages > @fluidframework/container-runtime > Summarizer

Summarizer is responsible for coordinating when to send generate and send summaries. It is the main entry point for summary work.

Signature:

export declare class Summarizer extends EventEmitter implements ISummarizer 

Extends: EventEmitter

Implements: ISummarizer

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(url, runtime, configurationGetter, internalsProvider, handleContext, summaryCollection) Constructs a new instance of the Summarizer class

Properties

List of properties for this class
Property Modifiers Type Description
handle IFluidHandle
IFluidLoadable this
IFluidRouter this
IFluidRunnable this
ISummarizer this
summaryCollection SummaryCollection

Methods

List of methods on this class
Method Modifiers Description
dispose() Disposes of resources after running. This cleanup will clear any outstanding timers and reset some of the state properties.
generateSummary(options) Implementation of SummarizerInternalsProvider.generateSummary
request(request)
run(onBehalfOf)
setSummarizer()
stop(reason) Stops the summarizer from running. This will complete the run promise, and also close the container.
updateOnBehalfOf(onBehalfOf)

Constructors

Summarizer.(constructor)

Constructs a new instance of the Summarizer class

Signature:

constructor(url: string, runtime: ISummarizerRuntime, configurationGetter: () => ISummaryConfiguration, internalsProvider: ISummarizerInternalsProvider, handleContext: IFluidHandleContext, summaryCollection: SummaryCollection);

Parameters

List of parameters
Parameter Type Description
url string
runtime ISummarizerRuntime
configurationGetter () => ISummaryConfiguration
internalsProvider ISummarizerInternalsProvider
handleContext IFluidHandleContext
summaryCollection SummaryCollection

Properties

handle

Signature:

get handle(): IFluidHandle<this>;

IFluidLoadable

Signature:

get IFluidLoadable(): this;

IFluidRouter

Signature:

get IFluidRouter(): this;

IFluidRunnable

Signature:

get IFluidRunnable(): this;

ISummarizer

Signature:

get ISummarizer(): this;

summaryCollection

Signature:

readonly summaryCollection: SummaryCollection;

Methods

dispose

Disposes of resources after running. This cleanup will clear any outstanding timers and reset some of the state properties.

Signature:

dispose(): void;

Returns:

void

generateSummary

Implementation of SummarizerInternalsProvider.generateSummary

Signature:

generateSummary(options: {
        fullTree: boolean;
        refreshLatestAck: boolean;
        summaryLogger: ITelemetryLogger;
    }): Promise<GenerateSummaryData | undefined>;

Parameters

List of parameters
Parameter Type Description
options { fullTree: boolean; refreshLatestAck: boolean; summaryLogger: ITelemetryLogger; }

Returns:

Promise<GenerateSummaryData | undefined>

request

Signature:

request(request: IRequest): Promise<IResponse>;

Parameters

List of parameters
Parameter Type Description
request IRequest

Returns:

Promise<IResponse>

run

Signature:

run(onBehalfOf: string): Promise<void>;

Parameters

List of parameters
Parameter Type Description
onBehalfOf string

Returns:

Promise<void>

setSummarizer

Signature:

setSummarizer(): Promise<Summarizer>;

Returns:

Promise<Summarizer>

stop

Stops the summarizer from running. This will complete the run promise, and also close the container.

Signature:

stop(reason: string): void;

Parameters

List of parameters
Parameter Type Description
reason string reason code for stopping

Returns:

void

updateOnBehalfOf

Signature:

updateOnBehalfOf(onBehalfOf: string): void;

Parameters

List of parameters
Parameter Type Description
onBehalfOf string

Returns:

void