Class FormattingRegion

constructor

• new FormattingRegion(
      nodes: CstNode[],
      collector: FormattingCollector,
  ): FormattingRegion

  Parameters

  • nodes: CstNode[]
  • collector: FormattingCollector

  Returns FormattingRegion

Readonlynodes

append

• append(formatting: FormattingAction): FormattingRegion

  Appends the specified formatting to all nodes of this region.

  Parameters

  • formatting: FormattingAction

  Returns FormattingRegion

prepend

• prepend(formatting: FormattingAction): FormattingRegion

  Prepends the specified formatting to all nodes of this region.

  Parameters

  • formatting: FormattingAction

  Returns FormattingRegion

slice

• slice(start?: number, end?: number): FormattingRegion

  Creates a copy of this region with a slice of the selected nodes. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

  Parameters

  • Optionalstart: number

    The beginning index of the specified portion of the region. If start is undefined, then the slice begins at index 0.
  • Optionalend: number

    The end index of the specified portion of the region. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the region.

  Returns FormattingRegion

surround

• surround(formatting: FormattingAction): FormattingRegion

  Sorrounds all nodes of this region with the specified formatting. Functionally the same as invoking prepend and append with the same formatting.

  Parameters

  • formatting: FormattingAction

  Returns FormattingRegion