NodeChangedDataProperties Interface
Data included for nodeChanged when the node is an object, map, or record node.
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 NodeChangedDataProperties<TNode extends TreeNode = TreeNode>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TNode | TreeNode | TreeNode |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| changedProperties | Alpha | readonly | ReadonlySet<TNode extends WithType<string, NodeKind.Object, infer TInfo> ? string & keyof TInfo : string> | Lists all the properties which changed on the node. |
Property Details
changedProperties
Lists all the properties which changed on the node.
For more information about our API support guarantees, see here.
Signature
readonly changedProperties: ReadonlySet<TNode extends WithType<string, NodeKind.Object, infer TInfo> ? string & keyof TInfo : string>;
Type: ReadonlySet<TNode extends WithType<string, NodeKind.Object, infer TInfo> ? string & keyof TInfo : string>
Remarks
This only includes changes to the node itself (which would trigger nodeChanged(unstable)).
The set should never be empty, since nodeChanged will only be triggered when there is a change, and for the supported node types, the only things that can change are properties.