IExperimentalIncrementalSummaryContext Interface
Packages > @fluidframework/runtime-definitions > IExperimentalIncrementalSummaryContext
- Can be deleted/changed at any time Contains the necessary information to allow DDSes to do incremental summaries
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/runtime-definitions/legacy.
For more information about our API support guarantees, see here .
Signature
export interface IExperimentalIncrementalSummaryContext
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| latestSummarySequenceNumber | Alpha |
readonly |
number | The sequence number of the most recent summary that was acknowledged by the server. |
| summaryPath | Alpha |
readonly |
string |
The path to the runtime/datastore/dds that is used to generate summary handles Note: Summary handles are nodes of the summary tree that point to previous parts of the last successful summary instead of being a blob or tree node This path contains the id of the data store and dds which should not be leaked to layers below them. Ideally, a layer should not know its own id. This is important for channel unification work and there has been a lot of work to remove these kinds of leakages. Some still exist, which have to be fixed but we should not be adding more dependencies. |
| summarySequenceNumber | Alpha |
readonly |
number | The sequence number of the summary generated that will be sent to the server. |
Property Details
latestSummarySequenceNumber
The sequence number of the most recent summary that was acknowledged by the server.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
readonly latestSummarySequenceNumber: number;
Type: number
summaryPath
The path to the runtime/datastore/dds that is used to generate summary handles Note: Summary handles are nodes of the summary tree that point to previous parts of the last successful summary instead of being a blob or tree node
This path contains the id of the data store and dds which should not be leaked to layers below them. Ideally, a layer should not know its own id. This is important for channel unification work and there has been a lot of work to remove these kinds of leakages. Some still exist, which have to be fixed but we should not be adding more dependencies.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
readonly summaryPath: string;
Type: string
summarySequenceNumber
The sequence number of the summary generated that will be sent to the server.
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/runtime-definitions/alpha.
For more information about our API support guarantees, see here .
Signature
readonly summarySequenceNumber: number;
Type: number