TreeChangeEventsAlpha Interface
Extension of TreeChangeEvents with a richer nodeChanged event.
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 TreeChangeEventsAlpha<TNode extends TreeNode = TreeNode> extends TreeChangeEvents
Extends: TreeChangeEvents
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TNode | TreeNode | TreeNode |
Remarks
Provides a nodeChanged event that includes a delta payload for array nodes and requires changedProperties for object, map, and record nodes. Use via TreeAlpha.on.
Properties
| Property | Alerts | Type | Description |
|---|---|---|---|
| nodeChanged | Alpha | (data: NodeChangedDataAlpha<TNode>) => void | Like TreeChangeEventsBeta.nodeChanged, but for array nodes the event data includes a delta payload describing the changes as a sequence of ArrayNodeDeltaOp values. |
Property Details
nodeChanged
Like TreeChangeEventsBeta.nodeChanged, but for array nodes the event data includes a delta payload describing the changes as a sequence of ArrayNodeDeltaOp values.
For more information about our API support guarantees, see here.
Signature
nodeChanged: (data: NodeChangedDataAlpha<TNode>) => void;
Type: (data: NodeChangedDataAlpha<TNode>) => void
Remarks
This defines a property which is a function instead of using the method syntax to avoid function bi-variance issues with the input data to the callback.