ICancellableSummarizerController Interface
Packages > @fluidframework/container-runtime > ICancellableSummarizerController
Similar to AbortController, but using promise instead of events
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 ICancellableSummarizerController extends ISummaryCancellationToken
Extends: ISummaryCancellationToken
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| stop(reason) |
Alpha
|
void |
Method Details
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 |