Class Position

An area in a source file, from start to end. The start point is the point right before the starting character. The end point is the point right after the last character. An empty position will have coinciding points.

Consider a file with one line, containing text "HELLO". The Position of such text will be Position(Point(1, 0), Point(1, 5)).

Index

Constructors

Properties

end source? start

Methods

compareTo contains equals isEmpty overlaps ofPoint

Constructors

constructor

new Position(start, end, source?): Position
Parameters
- start: Point
- end: Point
- Optional source: Source
Returns Position
- Defined in model/position.ts:110

Properties

`Readonly` end

end: Point

`Optional` source

source?: Source

`Readonly` start

start: Point

Methods

compareTo

compareTo(other): number
Parameters
- other: Position
Returns number
- Defined in model/position.ts:120

contains

contains(object): boolean
Tests whether the given object is contained in the interval represented by this object.
Parameters
- object: undefined | null | Point | Position | Node
  the object to test: could be a Point, a Position, or a Node.
Returns boolean
- Defined in model/position.ts:144

equals

equals(obj): boolean
Parameters
- obj: Position
Returns boolean
- Defined in model/position.ts:169

isEmpty

isEmpty(): boolean
If start and end are the same, then this Position is considered empty.

Returns boolean
- Defined in model/position.ts:136

overlaps

overlaps(position?): boolean
Tests whether the given position overlaps the interval represented by this object.
Parameters
- Optional position: Position
  the position
Returns boolean
- Defined in model/position.ts:160

`Static` ofPoint

ofPoint(point): Position
Parameters
- point: Point
Returns Position
- Defined in model/position.ts:116

Generated using TypeDoc