Class Position

constructor

• new Position(lineNumber: number, column: number): Position

  Parameters

  • lineNumber: number
  • column: number

  Returns Position

Readonlycolumn

ReadonlylineNumber

clone

• clone(): Position

  Clone this position.

  Returns Position

delta

• delta(deltaLineNumber?: number, deltaColumn?: number): Position

  Derive a new position from this position.

  Parameters

  • OptionaldeltaLineNumber: number

    line number delta

  • OptionaldeltaColumn: number

    column delta

  Returns Position

equals

• equals(other: IPosition): boolean

  Test if this position equals other position

  Parameters

  • other: IPosition

  Returns boolean

isBefore

• isBefore(other: IPosition): boolean

  Test if this position is before other position. If the two positions are equal, the result will be false.

  Parameters

  • other: IPosition

  Returns boolean

isBeforeOrEqual

• isBeforeOrEqual(other: IPosition): boolean

  Test if this position is before other position. If the two positions are equal, the result will be true.

  Parameters

  • other: IPosition

  Returns boolean

toJSON

• toJSON(): IPosition

  Returns IPosition

toString

• toString(): string

  Convert to a human-readable representation.

  Returns string

with

• with(newLineNumber?: number, newColumn?: number): Position

  Create a new position from this position.

  Parameters

  • OptionalnewLineNumber: number

    new line number

  • OptionalnewColumn: number

    new column

  Returns Position

Staticcompare

• compare(a: IPosition, b: IPosition): number

  A function that compares positions, useful for sorting

  Parameters

  • a: IPosition
  • b: IPosition

  Returns number

Staticequals

• equals(a: IPosition, b: IPosition): boolean

  Test if position a equals position b

  Parameters

  • a: IPosition
  • b: IPosition

  Returns boolean

StaticisBefore

• isBefore(a: IPosition, b: IPosition): boolean

  Test if position a is before position b. If the two positions are equal, the result will be false.

  Parameters

  • a: IPosition
  • b: IPosition

  Returns boolean

StaticisBeforeOrEqual

• isBeforeOrEqual(a: IPosition, b: IPosition): boolean

  Test if position a is before position b. If the two positions are equal, the result will be true.

  Parameters

  • a: IPosition
  • b: IPosition

  Returns boolean

StaticisIPosition

• isIPosition(obj: unknown): obj is IPosition

  Test if obj is an IPosition.

  Parameters

  • obj: unknown

  Returns obj is IPosition

Staticlift

• lift(pos: IPosition): Position

  Create a Position from an IPosition.

  Parameters

  • pos: IPosition

  Returns Position