Class BashDollarBrace

constructor

• new BashDollarBrace(): BashDollarBrace

• Returns BashDollarBrace

Readonly annotations

children

isChanged

parent

position

• get position(): Position

• Returns Position

addChild

• addChild(child): BashDollarBrace

• Add a child to this node

  Parameters

  • child: ShellNodeTypes | ShellNodeTypes[]

    the child to add

  Returns BashDollarBrace

  this

clone

• clone(): this

• Clone this node

  Returns this

  a clone of this node

diff

• diff(other): EditScript<default>

• Diff this node with another node

  Parameters

  • other: ShellNodeTypes

    the other node to diff with

  Returns EditScript<default>

  the diff between this node and the other node

find

• find(input): AbstractNode<ShellNodeTypes>[]

• Find all the nodes that match the query

  Parameters

  • input: string | QueryI

  Returns AbstractNode<ShellNodeTypes>[]

  the list of nodes that match query

getChild

• getChild<C>(nodeType): C

• Get the first child of the given type

  Type Parameters

  • C extends AbstractNode<any>

  Parameters

  • nodeType: (new (t) => C)

    the type of the node to find

    • • new (t): C

      • Parameters

        • t: any

        Returns C

  Returns C

  the first child of the given type

getChildren

• getChildren<C>(nodeType): C[]

• Get all the children of the given type

  Type Parameters

  • C extends AbstractNode<any>

  Parameters

  • nodeType: (new (t) => C)

    the type of the node to find

    • • new (t): C

      • Parameters

        • t: any

        Returns C

  Returns C[]

  the children of the given type

getElement

• getElement<C>(nodeType): C

• Get the first node of the given type

  Type Parameters

  • C extends AbstractNode<any>

  Parameters

  • nodeType: (new (t) => C)

    the type of the node to find

    • • new (t): C

      • Parameters

        • t: any

        Returns C

  Returns C

  the node of the given type or null if not found

getElements

• getElements<C>(nodeType): C[]

• Get all nodes of the given type

  Type Parameters

  • C extends AbstractNode<any>

  Parameters

  • nodeType: (new (t) => C)

    the type of the node to find

    • • new (t): C

      • Parameters

        • t: any

        Returns C

  Returns C[]

  the list of nodes

getParent

• getParent<C>(element): C

• Find the parent node of the given type

  Type Parameters

  • C extends AbstractNode<any>

  Parameters

  • element: (new (t) => C)

    the type of the parent to find

    • • new (t): C

      • Parameters

        • t: any

        Returns C

  Returns C

  the parent node or null if not found

hasChanges

• hasChanges(): boolean

• check if this node or one of its children has been changed

  Returns boolean

  true if this node or one of its children has been changed

hasChild

• hasChild(child): boolean

• Check if this node has the given child

  Parameters

  • child: ShellNodeTypes

    the child to check

  Returns boolean

  true if this node has the given child

isBefore

• isBefore(arg): boolean

• Check if this is before arg

  Parameters

  • arg: ShellNodeTypes

  Returns boolean

  true if this is before arg

isInside

• isInside(arg): boolean

• Check if arg is inside this node

  Parameters

  • arg: ShellNodeTypes

    the node to check

  Returns boolean

  true if arg is inside this node

iterate

• iterate(callback, filter?): void

• Iterate over the children nodes (non recursive)

  Parameters

  • callback: ((node, index) => void)

    callback function to call for each node

    • • (node, index): void

      • Parameters

        • node: ShellNodeTypes
        • index: number

        Returns void

  • Optional filter: ((node) => boolean)
    • • (node): boolean

      • Parameters

        • node: ShellNodeTypes

        Returns boolean

  Returns void

match

• match(query): any

• Check if this node is before the other node

  Parameters

  • query: QueryI

    check if this node match the query

  Returns any

  true if this node matches the query

printer

• printer(): ShellPrinter

• Returns ShellPrinter

remove

• remove(): BashDollarBrace

• Remove this node from the tree

  Returns BashDollarBrace

  this

replace

• replace(node): BashDollarBrace

• Replace this by the given node

  Parameters

  • node: ShellNodeTypes

    the replacement node

  Returns BashDollarBrace

  this

setPosition

• setPosition(position): BashDollarBrace

• Parameters

  • position: Position

  Returns BashDollarBrace

toJSON

• toJSON(): {
      children?: {
          children?: { type: string; position: { lineStart: number; columnStart: number; lineEnd: number; columnEnd: number; }; children?: ...[]; value?: string; }[];
          position: {
              columnEnd: number;
              columnStart: number;
              lineEnd: number;
              lineStart: number;
          };
          type: string;
          value?: string;
      }[];
      position: {
          columnEnd: number;
          columnStart: number;
          lineEnd: number;
          lineStart: number;
      };
      type: string;
      value?: string;
  }

• Returns {
      children?: {
          children?: { type: string; position: { lineStart: number; columnStart: number; lineEnd: number; columnEnd: number; }; children?: ...[]; value?: string; }[];
          position: {
              columnEnd: number;
              columnStart: number;
              lineEnd: number;
              lineStart: number;
          };
          type: string;
          value?: string;
      }[];
      position: {
          columnEnd: number;
          columnStart: number;
          lineEnd: number;
          lineStart: number;
      };
      type: string;
      value?: string;
  }

  • Optional children?: {
        children?: { type: string; position: { lineStart: number; columnStart: number; lineEnd: number; columnEnd: number; }; children?: ...[]; value?: string; }[];
        position: {
            columnEnd: number;
            columnStart: number;
            lineEnd: number;
            lineStart: number;
        };
        type: string;
        value?: string;
    }[]

  • position: {
        columnEnd: number;
        columnStart: number;
        lineEnd: number;
        lineStart: number;
    }

    • columnEnd: number

    • columnStart: number

    • lineEnd: number

    • lineStart: number

  • type: string

  • Optional value?: string

toString

• toString(asPrettyPrint?): string

• Return a string representation of this node

  Parameters

  • asPrettyPrint: boolean = true

    true if the output should be pretty printed

  Returns string

  a string representation of this node

traverse

• traverse(callback, __namedParameters?): boolean

• traverse all children recursively

  Parameters

  • callback: ((node) => boolean | void)

    returns false to stop the traverse

    • • (node): boolean | void

      • Parameters

        • node: ShellNodeTypes

        Returns boolean | void

  • __namedParameters: {
        includeSelf: boolean;
    } = ...

    • includeSelf: boolean

  Returns boolean

  false if not everything has been traversed