Interface TypeGuard<D, S>

Represents the type guard object for a graph type. For example, BaseGraph.TypeGuard is a Graph.TypeGuard.

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

Type Parameters

D extends BaseGraph.Data
S extends BaseGraph.ScratchData

Index

Methods

isDataCompatible isScratchDataCompatible

Methods

isDataCompatible

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

isScratchDataCompatible

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