@eagleoutice/flowr - v2.15.8
    Preparing search index...
    DfEdge: {
        doesNotIncludeType(
            this: void,
            __namedParameters: DfEdgeLike,
            any: EdgeType,
        ): boolean;
        hasAnyType(this: void, __namedParameters: DfEdgeLike): boolean;
        hasNoType(this: void, __namedParameters: DfEdgeLike): boolean;
        includesType(
            this: void,
            __namedParameters: DfEdgeLike,
            typesToInclude: EdgeType,
        ): boolean;
        isOnlyControlFlow(this: void, __namedParameters: DfEdgeLike): boolean;
        isOnlyType(
            this: void,
            __namedParameters: DfEdgeLike,
            only: EdgeType,
        ): boolean;
        name: "DfEdge";
        splitTypes(this: void, __namedParameters: DfEdgeLike): EdgeType[];
        typesToNames(this: void, __namedParameters: DfEdgeLike): Set<EdgeTypeName>;
        typeToName(this: void, type: EdgeType): string;
        without(this: void, __namedParameters: DfEdgeLike, drop: number): DfEdge;
    }

    Helper Functions to work with DfEdge and EdgeType.

    Type Declaration

    • doesNotIncludeType: function
    • hasAnyType: function
      • Whether the edge carries any type at all. Counterpart of DfEdge#hasNoType.

        Parameters

        Returns boolean

        DfEdge.hasAnyType({ types: EdgeType.Reads }) // true
        DfEdge.hasAnyType({ types: 0 }) // false
    • hasNoType: function
    • includesType: function
      • 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

        Returns boolean

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

        Counterpart of DfEdge#doesNotIncludeType.

    • isOnlyControlFlow: function
    • isOnlyType: function
      • Check whether the edge carries the given types and nothing else. Strict counterpart of DfEdge#includesType, which already holds if one of the bits is set.

        Parameters

        Returns boolean

        DfEdge.isOnlyType({ types: EdgeType.Reads | EdgeType.Calls }, EdgeType.Reads)                  // false
        DfEdge.isOnlyType({ types: EdgeType.Reads | EdgeType.Calls }, EdgeType.Reads | EdgeType.Calls) // true
    • Readonlyname: "DfEdge"
    • splitTypes: function
      • Takes joint edge types and splits them into their individual components.

        Parameters

        Returns EdgeType[]

        DfEdge.splitTypes({ types: EdgeType.Reads | EdgeType.DefinedBy });
        // returns [EdgeType.Reads, EdgeType.DefinedBy]
    • typesToNames: function
    • typeToName: function
    • without: function