Interface TypeGuard<D, S>

Represents the type guard object for an edge type. For example, BaseEdge.TypeGuard is an Edge.TypeGuard.

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

Type Parameters

D extends BaseEdge.Data
S extends BaseEdge.ScratchData

Index

Methods

isDataCompatible isScratchDataCompatible

Methods

isDataCompatible

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

isScratchDataCompatible

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