Type Alias Edge<D, S, E>

Represents an edge type. All edge types must be subtypes of BaseEdge. An edge type has 5 components:

A class with functionality (Edge.Class);
A builder class (optional) (Edge.Builder);
A type guard object (Edge.TypeGuard);
A data type (BaseEdge.Data);
A scratch data type (BaseEdge.ScratchData).

type Edge<
    D extends BaseEdge.Data,
    S extends BaseEdge.ScratchData,
    E extends BaseEdge.Class<D, S>,
> = {
    Class: Edge.Class<D, S, E>;
    TypeGuard: Edge.TypeGuard<D, S>;
}

Type Parameters

D extends BaseEdge.Data
Type parameter for the data contained in the edge type.
S extends BaseEdge.ScratchData
Type parameter for the scratch data contained in the edge type.
E extends BaseEdge.Class<D, S>
Type parameter for the instance of the class with functionality for this edge type.

Index

Properties

Class TypeGuard

Properties

Class

Class: Edge.Class<D, S, E>

The class with functionality for the edge type. See Edge.Class.

TypeGuard

TypeGuard: Edge.TypeGuard<D, S>

The type guard object for the edge type. See Edge.TypeGuard.