Skip to main content
Version: v1

BuildTreeNode Interface

Node for use in a Build change, which is composed of a definition describing what this nodes type, an identifier identifying this node within the tree, and a payload containing an opaque serializable piece of data. An identifier can be provided explicitly if the node must be referred to before the results of the Change containing this BuildTreeNode can be observed. If identifier is not supplied, one will be generated for it in an especially efficient manner that allows for compact storage and transmission and thus this property should be omitted if convenient. See the SharedTree readme for more on the tree format.

Signature

export interface BuildTreeNode extends HasVariadicTraits<BuildNode>

Extends: HasVariadicTraits<BuildNode

Properties

Property Modifiers Type Description
definition string
identifier optional NodeId
payload optional Payload

Property Details

definition

Signature

definition: string;

Type: string

identifier

Signature

identifier?: NodeId;

Type: NodeId

payload

Signature

payload?: Payload;

Type: Payload