Variable DfEdge

Type Declaration

• doesNotIncludeType: function

  • doesNotIncludeType(
        this: void,
        __namedParameters: DfEdgeLike,
        any: EdgeType,
    ): boolean

    Check if the given-edge type does not include the given type. As types are bitmasks, you can combine multiple types with a bitwise OR (|). Counterpart of DfEdge#includesType.

    Parameters

    • this: void
    • __namedParameters: DfEdgeLike
    • any: EdgeType

    Returns boolean

• includesType: function

  • includesType(
        this: void,
        __namedParameters: DfEdgeLike,
        typesToInclude: EdgeType,
    ): boolean

    Check if the given-edge type has any of the given types. As types are bitmasks, you can combine multiple types with a bitwise OR (|).

    Parameters

    • this: void
    • __namedParameters: DfEdgeLike
    • typesToInclude: EdgeType

    Returns boolean

    Example

    edgeIncludesType({ types: EdgeType.Reads }, EdgeType.Reads | EdgeType.DefinedBy) // true
    Copy

    Counterpart of DfEdge#doesNotIncludeType.

• Readonlyname: "DfEdge"

• splitTypes: function

  • splitTypes(this: void, __namedParameters: DfEdgeLike): EdgeType[]

    Takes joint edge types and splits them into their individual components.

    Parameters

    • this: void
    • __namedParameters: DfEdgeLike

    Returns EdgeType[]

    Example

    DfEdge.splitTypes({ types: EdgeType.Reads | EdgeType.DefinedBy });
    // returns [EdgeType.Reads, EdgeType.DefinedBy]
    Copy

• typesToNames: function

  • typesToNames(this: void, __namedParameters: DfEdgeLike): Set<EdgeTypeName>

    Takes joint edge types and returns their human-readable names.

    Parameters

    • this: void
    • __namedParameters: DfEdgeLike

    Returns Set<EdgeTypeName>

• typeToName: function

  • typeToName(this: void, type: EdgeType): string

    Only use this function to retrieve a human-readable name if you know that it is a single bitmask. Otherwise, use DfEdge#typesToNames which handles these cases.

    Parameters

    • this: void
    • type: EdgeType

    Returns string