SummaryCollection Class
Packages > @fluidframework/container-runtime > SummaryCollection
Data structure that looks at the op stream to track summaries as they are broadcast, acked and nacked. It provides functionality for watching specific summaries.
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 SummaryCollection extends TypedEventEmitter<ISummaryCollectionOpEvents>
Extends: TypedEventEmitter <ISummaryCollectionOpEvents >
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)(deltaManager, logger) | Alpha |
Constructs a new instance of the SummaryCollection class |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| latestAck | Alpha |
readonly |
IAckedSummary | undefined | |
| opsSinceLastAck | Alpha |
readonly |
number |
Constructor Details
(constructor)
Constructs a new instance of the SummaryCollection 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(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, logger: ITelemetryLoggerExt);
Parameters
| Parameter | Type | Description |
|---|---|---|
| deltaManager | IDeltaManager<ISequencedDocumentMessage, IDocumentMessage> | |
| logger | ITelemetryLoggerExt |
Property Details
latestAck
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 latestAck(): IAckedSummary | undefined;
Type: IAckedSummary | undefined
opsSinceLastAck
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 opsSinceLastAck(): number;
Type: number