Class Position

constructor

• new Position(lineNumber, column): Position

• Parameters

  • lineNumber: number
  • column: number

  Returns Position

Readonly column

Readonly lineNumber

clone

• clone(): Position

• Clone this position.

  Returns Position

delta

• delta(deltaLineNumber?, deltaColumn?): Position

• Derive a new position from this position.

  Parameters

  • Optional deltaLineNumber: number

    line number delta
  • Optional deltaColumn: number

    column delta

  Returns Position

equals

• equals(other): boolean

• Test if this position equals other position

  Parameters

  • other: IPosition

  Returns boolean

isBefore

• isBefore(other): 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): 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?, newColumn?): Position

• Create a new position from this position.

  Parameters

  • Optional newLineNumber: number

    new line number
  • Optional newColumn: number

    new column

  Returns Position

Static compare

• compare(a, b): number

• A function that compares positions, useful for sorting

  Parameters

  • a: IPosition
  • b: IPosition

  Returns number

Static equals

• equals(a, b): boolean

• Test if position a equals position b

  Parameters

  • a: IPosition
  • b: IPosition

  Returns boolean

Static isBefore

• isBefore(a, b): 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

Static isBeforeOrEqual

• isBeforeOrEqual(a, b): 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

Static isIPosition

• isIPosition(obj): obj is IPosition

• Test if obj is an IPosition.

  Parameters

  • obj: unknown

  Returns obj is IPosition

Static lift

• lift(pos): Position

• Create a Position from an IPosition.

  Parameters

  • pos: IPosition

  Returns Position