ISummarizer Interface
Packages > @fluidframework/container-runtime > ISummarizer
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 ISummarizer extends IEventProvider<ISummarizerEvents>
Extends: IEventProvider <ISummarizerEvents >
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| ISummarizer | Alpha |
optional, readonly |
ISummarizer | Allows ISummarizer to be used with our FluidObject pattern. |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| close() | Alpha |
void | |
| enqueueSummarize(options) | Alpha |
EnqueueSummarizeResult | Enqueue an attempt to summarize after the specified sequence number. If afterSequenceNumber is provided, the summarize attempt is "enqueued" to run once an eligible op comes in with sequenceNumber \>= afterSequenceNumber. |
| run(onBehalfOf) | Alpha |
Promise<SummarizerStopReason> | |
| stop(reason) | Alpha |
void | |
| summarizeOnDemand(options) | Alpha |
ISummarizeResults | Attempts to generate a summary on demand. If already running, takes no action. |
Property Details
ISummarizer
Allows ISummarizer to be used with our FluidObject pattern.
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 ISummarizer?: ISummarizer;
Type: ISummarizer
Method Details
close
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
close(): void;
enqueueSummarize
Enqueue an attempt to summarize after the specified sequence number. If afterSequenceNumber is provided, the summarize attempt is “enqueued” to run once an eligible op comes in with sequenceNumber >= afterSequenceNumber.
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
enqueueSummarize(options: IEnqueueSummarizeOptions): EnqueueSummarizeResult;
Parameters
| Parameter | Type | Description |
|---|---|---|
| options | IEnqueueSummarizeOptions | options controlling the summarize attempt |
Returns
an object containing an alreadyEnqueued flag to indicate if another summarize attempt has already been enqueued. It also may contain an overridden flag when alreadyEnqueued is true, that indicates whether this attempt forced the previous attempt to abort. If this attempt becomes enqueued, it returns an object containing promises that resolve as the summarize attempt progresses. They will resolve with success false if a failure is encountered.
Return type: EnqueueSummarizeResult
run
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
run(onBehalfOf: string): Promise<SummarizerStopReason>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| onBehalfOf | string |
Returns
Return type: Promise<SummarizerStopReason >
stop
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
stop(reason: SummarizerStopReason): void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| reason | SummarizerStopReason |
summarizeOnDemand
Attempts to generate a summary on demand. If already running, takes no action.
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
summarizeOnDemand(options: IOnDemandSummarizeOptions): ISummarizeResults;
Parameters
| Parameter | Type | Description |
|---|---|---|
| options | IOnDemandSummarizeOptions | options controlling the summarize attempt |
Returns
an alreadyRunning promise if a summarize attempt is already in progress, which will resolve when the current attempt completes. At that point caller can decide to try again or not. Otherwise, it will return an object containing promises that resolve as the summarize attempt progresses. They will resolve with success false if a failure is encountered.
Return type: ISummarizeResults