CustomMetadataTree Interface
A tree representing the nesting structure of transaction metadata.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
This type is "sealed," meaning that code outside of the library defining it should not implement or extend it. Future versions of this type may add members or make typing of readonly members more specific.
Signature
/** @sealed */
export interface CustomMetadataTree
Remarks
Each transaction contributes a node whose metadata is its metadata (or undefined if none was provided). When transactions are nested, inner transaction nodes become children of outer ones.
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| children | Alpha | readonly | readonly CustomMetadataTree[] | The metadata trees of any nested transactions within this one. |
| metadata | Alpha | readonly | JsonCompatibleReadOnlyObject | undefined | The metadata supplied by this transaction, or undefined if it supplied none. |
Property Details
children
The metadata trees of any nested transactions within this one.
For more information about our API support guarantees, see here.
Signature
readonly children: readonly CustomMetadataTree[];
Type: readonly CustomMetadataTree[]
metadata
The metadata supplied by this transaction, or undefined if it supplied none.
For more information about our API support guarantees, see here.
Signature
readonly metadata: JsonCompatibleReadOnlyObject | undefined;
Type: JsonCompatibleReadOnlyObject | undefined