ISummarizer Interface

Packages > @fluidframework/container-runtime > ISummarizer

Signature:

export interface ISummarizer extends IEventProvider<ISummarizerEvents>, IFluidRouter, IFluidRunnable, IFluidLoadable 

Extends: IEventProvider<ISummarizerEvents>, IFluidRouter, IFluidRunnable, IFluidLoadable

Methods

List of methods of this class
Method Description
run(onBehalfOf)
setSummarizer() Returns a promise that will be resolved with the next Summarizer after context reload
stop(reason)
updateOnBehalfOf(onBehalfOf)

Methods

run

Signature:

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

Parameters

List of parameters
Parameter Type Description
onBehalfOf string

Returns:

Promise<void>

setSummarizer

Returns a promise that will be resolved with the next Summarizer after context reload

Signature:

setSummarizer(): Promise<Summarizer>;

Returns:

Promise<Summarizer>

stop

Signature:

stop(reason?: string): void;

Parameters

List of parameters
Parameter Type Description
reason string

Returns:

void

updateOnBehalfOf

Signature:

updateOnBehalfOf(onBehalfOf: string): void;

Parameters

List of parameters
Parameter Type Description
onBehalfOf string

Returns:

void