Skip to main content
Version: v1

SetValueInternal_0_0_2 Interface

Modifies the payload of a node.

Signature​

export interface SetValueInternal_0_0_2

Properties​

Property Type Description
nodeToModify StableNodeId
payload Payload | null Sets or clears the payload. To improve ease of forwards compatibility, an explicit null value is used to represent the clearing of a payload. SetValue may use undefined in future API versions to mean "don't change the payload" (which is useful if e.g. other fields are added to SetValue that can be changed without altering the payload)
type typeof ChangeTypeInternal.SetValue

Property Details​

nodeToModify​

Signature​

readonly nodeToModify: StableNodeId;

Type: StableNodeId

payload​

Sets or clears the payload. To improve ease of forwards compatibility, an explicit null value is used to represent the clearing of a payload. SetValue may use undefined in future API versions to mean "don't change the payload" (which is useful if e.g. other fields are added to SetValue that can be changed without altering the payload)

Signature​

readonly payload: Payload | null;

Type: Payload | null

type​

Signature​

readonly type: typeof ChangeTypeInternal.SetValue;

Type: typeof ChangeTypeInternal.SetValue