API reference · generated from source
Interface: IRetreeChangeLogEntry#
Defined in: types.ts:89
One entry delivered to a createChangeLogTap sink.
Properties#
| Property | Type | Description | Defined in |
|---|---|---|---|
kind | "nodeChanged" | "nodeRemoved" | Which emission produced the entry. nodeChanged carries the change records; nodeRemoved reports a node leaving its tree and has no records. | types.ts:95 |
path | string[] | undefined | Best-effort key path from the tree root to the changed node, root-first and excluding the root itself ([] for the root). undefined when the node could not be resolved (for example, it was already removed from its tree) or when paths are disabled via IChangeLogTapOptions.paths. | types.ts:108 |
records | INodeFieldChanges<unknown>[] | The raw change records from the emission, exactly as Retree listeners receive them. Empty for nodeRemoved entries. | types.ts:113 |
rootName | string | undefined | The name registered for the node's tree root via Retree.registerRootName, or undefined for unnamed trees. | types.ts:100 |
silent | boolean | true when the emission happened inside a Retree.runSilent window — application listeners were suppressed, but the write still occurred. | types.ts:124 |
transaction | boolean | true when the emission happened inside an outermost Retree.runTransaction window (including writes made by listeners during the transaction's flush). | types.ts:119 |