Variable Node

Type declaration

• • (
        name: string,
        signatures: readonly (
            | {
                _tag: "PropertySignature";
                name: PropertyKey;
                reference: Reference;
            }
            | { _tag: "IndexSignature"; name: PropertyKey; reference: Reference }
        )[],
        nodeAttributes?: NodeAttributesObject,
        edgeAttributes?: EdgeAttributesObject,
    ): Node

  • Parameters

    • name: string

      Type name.
    • signatures: readonly (
          | { _tag: "PropertySignature"; name: PropertyKey; reference: Reference }
          | { _tag: "IndexSignature"; name: PropertyKey; reference: Reference }
      )[]

      List of struct property and/or index signatures.
    • nodeAttributes: NodeAttributesObject = {}

      Optional Graphviz node options.
    • edgeAttributes: EdgeAttributesObject = {}

      Optional Graphviz edge options for all edges exiting this node.

    Returns Node

• collectTargets: function

  • collectTargets(__namedParameters: Node): string[]

    Collect all reference targets from node signatures.

    Parameters

    • __namedParameters: Node

    Returns string[]

• mapReferences: function

  • mapReferences(
        f: (reference: Reference) => Reference,
    ): (__namedParameters: Node) => Node

    Map over all references found in a node.

    Parameters

    • f: (reference: Reference) => Reference

    Returns (__namedParameters: Node) => Node

• setAttributes: function

  • setAttributes(nodeAttributes: NodeAttributesObject): (node: Node) => Node

    Set Graphviz node attributes of the node.

    Parameters

    • nodeAttributes: NodeAttributesObject

    Returns (node: Node) => Node