Variable RProject

Type Declaration

• asNodes: function

  • asNodes<OtherInfo>(this: void, project: RProject<OtherInfo>): RNode<OtherInfo>[]

    Flattens the project to an array of nodes by collecting the root nodes of each file.

    Type Parameters

    • OtherInfo

    Parameters

    • this: void
    • project: RProject<OtherInfo>

    Returns RNode<OtherInfo>[]

• collectAllIds: function

  • collectAllIds<OtherInfo>(
        this: void,
        project: RProject<OtherInfo & ParentInformation>,
    ): Set<NodeId>

    Collects all node ids within a project

    Type Parameters

    • OtherInfo

    Parameters

    • this: void
    • project: RProject<OtherInfo & ParentInformation>

      The project to collect ids from

    Returns Set<NodeId>

    See

    • RNode.collectAllIds - to stop collecting at certain nodes
    • RProject.collectAllIdsWithStop - to stop collecting at certain nodes

• collectAllIdsWithStop: function

  • collectAllIdsWithStop<OtherInfo>(
        this: void,
        project: RProject<OtherInfo & ParentInformation>,
        stop: (node: RNode<OtherInfo & ParentInformation>) => boolean,
    ): Set<NodeId>

    Collects all node ids within a project, but stops collecting at nodes where the given stop function returns true.

    Type Parameters

    • OtherInfo

    Parameters

    • this: void
    • project: RProject<OtherInfo & ParentInformation>

      The project to collect ids from

    • stop: (node: RNode<OtherInfo & ParentInformation>) => boolean

      A function that determines whether to stop collecting at a given node, does not stop by default

    Returns Set<NodeId>

    See

    • RNode.collectAllIdsWithStop - to collect all ids without stopping
    • RProject.collectAllIds - to collect all ids without stopping

• is: function

  • is<OtherInfo = object>(this: void, node: unknown): node is RProject<OtherInfo>

    Type guard for RProject nodes.

    Type Parameters

    • OtherInfo = object

    Parameters

    • this: void
    • node: unknown

    Returns node is RProject<OtherInfo>

• merge: function

  • merge<Info = object>(
        this: void,
        projects: readonly RProject<Info>[],
    ): RProject<Info>

    Merge multiple projects into a single one by concatenating their files. This will remove the info property of the resulting project.

    Type Parameters

    • Info = object

    Parameters

    • this: void
    • projects: readonly RProject<Info>[]

    Returns RProject<Info>

• Readonlyname: "RProject"

• visitAst: function

  • visitAst<OtherInfo>(
        this: void,
        project: RProject<OtherInfo>,
        onVisit?: OnEnter<OtherInfo>,
        onExit?: OnExit<OtherInfo>,
    ): void

    Visits all nodes in the project by visiting the root of each file.

    Type Parameters

    • OtherInfo

    Parameters

    • this: void
    • project: RProject<OtherInfo>

      The project to visit file by file

    • OptionalonVisit: OnEnter<OtherInfo>

      Called before visiting the subtree of each node. Can be used to stop visiting the subtree starting with this node (return true stop)

    • OptionalonExit: OnExit<OtherInfo>

      Called after the subtree of a node has been visited, called for leafs too (even though their subtree is empty)

    Returns void