Class Position

constructor

• new Position(line, character): Position

• Parameters

  • line: number

    A zero-based line value.
  • character: number

    A zero-based character value.

  Returns Position

Readonly character

Readonly line

compareTo

• compareTo(other): number

• Compare this to other.

  Parameters

  • other: Position

    A position.

  Returns number

  A number smaller than zero if this position is before the given position, a number greater than zero if this position is after the given position, or zero when this and the given position are equal.

isAfter

• isAfter(other): boolean

• Check if this position is after other.

  Parameters

  • other: Position

    A position.

  Returns boolean

  true if position is on a greater line or on the same line on a greater character.

isAfterOrEqual

• isAfterOrEqual(other): boolean

• Check if this position is after or equal to other.

  Parameters

  • other: Position

    A position.

  Returns boolean

  true if position is on a greater line or on the same line on a greater or equal character.

isBefore

• isBefore(other): boolean

• Check if this position is before other.

  Parameters

  • other: Position

    A position.

  Returns boolean

  true if position is on a smaller line or on the same line on a smaller character.

isBeforeOrEqual

• isBeforeOrEqual(other): boolean

• Check if this position is before or equal to other.

  Parameters

  • other: Position

    A position.

  Returns boolean

  true if position is on a smaller line or on the same line on a smaller or equal character.

isEqual

• isEqual(other): boolean

• Check if this position is equal to other.

  Parameters

  • other: Position

    A position.

  Returns boolean

  true if the line and character of the given position are equal to the line and character of this position.

translate

• translate(lineDelta?, characterDelta?): Position

• Create a new position relative to this position.

  Parameters

  • Optional lineDelta: number

    Delta value for the line value, default is 0.
  • Optional characterDelta: number

    Delta value for the character value, default is 0.

  Returns Position

  A position which line and character is the sum of the current line and character and the corresponding deltas.
• translate(change): Position

• Derived a new position relative to this position.

  Parameters

  • change: {
        characterDelta?: number;
        lineDelta?: number;
    }

    An object that describes a delta to this position.

    • Optional characterDelta?: number

    • Optional lineDelta?: number

  Returns Position

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

with

• with(line?, character?): Position

• Create a new position derived from this position.

  Parameters

  • Optional line: number

    Value that should be used as line value, default is the existing value
  • Optional character: number

    Value that should be used as character value, default is the existing value

  Returns Position

  A position where line and character are replaced by the given values.
• with(change): Position

• Derived a new position from this position.

  Parameters

  • change: {
        character?: number;
        line?: number;
    }

    An object that describes a change to this position.

    • Optional character?: number

    • Optional line?: number

  Returns Position

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