Class LineRange

constructor

• new LineRange(startLineNumber, lineCount): LineRange

• Parameters

  • startLineNumber: number

    A zero-based number of the start line. The range starts exactly at the beginning of this line.
  • lineCount: number

  Returns LineRange

Readonly lineCount

Readonly startLineNumber

endLineNumberExclusive

• get endLineNumberExclusive(): number

• A zero-based number of the end line. The range ends just before the beginning of this line.

  Returns number

isEmpty

• get isEmpty(): boolean

• Returns boolean

contains

• contains(other): boolean

• Parameters

  • other: LineRange

  Returns boolean

containsLine

• containsLine(lineNumber): boolean

• Parameters

  • lineNumber: number

  Returns boolean

delta

• delta(lineDelta): LineRange

• Parameters

  • lineDelta: number

  Returns LineRange

deltaEnd

• deltaEnd(lineDelta): LineRange

• Parameters

  • lineDelta: number

  Returns LineRange

deltaStart

• deltaStart(lineDelta): LineRange

• Parameters

  • lineDelta: number

  Returns LineRange

equals

• equals(other): boolean

• Parameters

  • other: LineRange

  Returns boolean

getLines

• getLines(document): string[]

• Parameters

  • document: TextEditorDocument

  Returns string[]

isAfter

• isAfter(other): boolean

• Parameters

  • other: LineRange

  Returns boolean

isBefore

• isBefore(other): boolean

• Parameters

  • other: LineRange

  Returns boolean

join

• join(other): LineRange

• Parameters

  • other: LineRange

  Returns LineRange

toInclusiveRange

• toInclusiveRange(): undefined | Range

• Returns undefined | Range

toInclusiveRangeOrEmpty

• toInclusiveRangeOrEmpty(): Range

• Returns Range

toRange

• toRange(): Range

• Returns Range

toString

• toString(): string

• Returns string

touches

• touches(other): boolean

• Returns false if there is at least one line between this and other.

  Parameters

  • other: LineRange

  Returns boolean

Static compareByStart

• compareByStart(a, b): number

• Parameters

  • a: LineRange
  • b: LineRange

  Returns number

Static fromLineNumbers

• fromLineNumbers(startLineNumber, endExclusiveLineNumber): LineRange

• Parameters

  • startLineNumber: number
  • endExclusiveLineNumber: number

  Returns LineRange