Class Range

constructor

• new Range(start: Position, end: Position): Range

  Create a new range from two positions. If start is not before or equal to end, the values will be swapped.

  Parameters

  • start: Position

    A position.

  • end: Position

    A position.

  Returns Range

• new Range(
      startLine: number,
      startCharacter: number,
      endLine: number,
      endCharacter: number,
  ): Range

  Create a new range from number coordinates. It is a shorter equivalent of using new Range(new Position(startLine, startCharacter), new Position(endLine, endCharacter))

  Parameters

  • startLine: number

    A zero-based line value.

  • startCharacter: number

    A zero-based character value.

  • endLine: number

    A zero-based line value.

  • endCharacter: number

    A zero-based character value.

  Returns Range

Readonlyend

isEmpty

isSingleLine

Readonlystart

contains

• contains(positionOrRange: Range | Position): boolean

  Check if a position or a range is contained in this range.

  Parameters

  • positionOrRange: Range | Position

    A position or a range.

  Returns boolean

  true if the position or range is inside or equal to this range.

intersection

• intersection(range: Range): Range | undefined

  Intersect range with this range and returns a new range or undefined if the ranges have no overlap.

  Parameters

  • range: Range

    A range.

  Returns Range | undefined

  A range of the greater start and smaller end positions. Will return undefined when there is no overlap.

isEqual

• isEqual(other: Range): boolean

  Check if other equals this range.

  Parameters

  • other: Range

    A range.

  Returns boolean

  true when start and end are equal to start and end of this range.

union

• union(other: Range): Range

  Compute the union of other with this range.

  Parameters

  • other: Range

    A range.

  Returns Range

  A range of smaller start position and the greater end position.

with

• with(start?: Position, end?: Position): Range

  Derived a new range from this range.

  Parameters

  • Optionalstart: Position

    A position that should be used as start. The default value is the current start.

  • Optionalend: Position

    A position that should be used as end. The default value is the current end.

  Returns Range

  A range derived from this range with the given start and end position. If start and end are not different this range will be returned.

• with(change: { end?: Position; start?: Position }): Range

  Derived a new range from this range.

  Parameters

  • change: { end?: Position; start?: Position }

    An object that describes a change to this range.

    • Optionalend?: Position

      New end position, defaults to current end

    • Optionalstart?: Position

      New start position, defaults to current start

  Returns Range

  A range that reflects the given change. Will return this range if the change is not changing anything.