Interface TypeGuard<D, S>

Represents the type guard object for a node type. For example, BaseNode.TypeGuard is a Node.TypeGuard.

interface TypeGuard<D extends BaseNode.Data, S extends BaseNode.ScratchData> {
isDataCompatible(data: BaseNode.Data): data is D;
isScratchDataCompatible(sData: BaseNode.ScratchData): sData is S;
}

Type Parameters

D extends BaseNode.Data
S extends BaseNode.ScratchData

Index

Methods

isDataCompatible isScratchDataCompatible

Methods

isDataCompatible

isDataCompatible(data: BaseNode.Data): data is D
Type guard for the data object of the node.
Parameters
- data: BaseNode.Data
  The data object to be checked.
Returns data is D
Whether the data object is compatible with the node type.
- Defined in flow/src/graph/Node.ts:98

isScratchDataCompatible

isScratchDataCompatible(sData: BaseNode.ScratchData): sData is S
Type guard for the scratch data object of the node.
Parameters
- sData: BaseNode.ScratchData
  The scratch data object to be checked.
Returns sData is S
Whether the scratch data object is compatible with the node type.
- Defined in flow/src/graph/Node.ts:106