ISummarizeInternalResult Interface
Packages > @fluidframework/runtime-definitions > ISummarizeInternalResult
Contains the same data as ISummaryResult but in order to avoid naming collisions, the data store summaries are wrapped around an array of labels identified by pathPartsForChildren.
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 ISummarizeInternalResult extends ISummarizeResult
Extends: ISummarizeResult
Example
id:""
pathPartsForChildren: ["path1"]
stats: ...
summary:
...
"path1":
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| id | Alpha |
string | ||
| pathPartsForChildren | Alpha |
optional |
string[] | Additional path parts between this node's ID and its children's IDs. |
Property Details
id
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
id: string;
Type: string
pathPartsForChildren
Additional path parts between this node’s ID and its children’s IDs.
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
pathPartsForChildren?: string[];
Type: string[]