Class Mark

Readonly column

Readonly line

Readonly note

Readonly offset

end

• get end(): Mark

• The last source position covered by this Tag.

  Returns Mark

start

• get start(): Mark

• The first source position covered by this Tag.

  Returns Mark

Static zero

• get zero(): Mark

• Returns a Mark at byte offset 0, line 1, and column 1, with no attached note.

  Returns Mark

debug

• debug<T>(output): Output<T>

• Writes a developer readable, debug-formatted string representation of this object to output.

  Type Parameters

  • T

  Parameters

  • output: Output<T>

  Returns Output<T>

  the continuation of the output.

  Throws

  [[OutputException]] if the output exits the cont state before the full debug string has been written.

display

• display<T>(output): Output<T>

• Writes a human readable, display-formatted string representation of this object to output.

  Type Parameters

  • T

  Parameters

  • output: Output<T>

  Returns Output<T>

  the continuation of the output.

  Throws

  [[OutputException]] if the output exits the cont state before the full display string has been written.

equals

• equals(that): boolean

• Parameters

  • that: unknown

  Returns boolean

hashCode

• hashCode(): number

• Returns number

max

• max(that): Mark

• Returns this position, if its byte offset is greater than or equal to that position; otherwise returns that position.

  Parameters

  • that: Mark

  Returns Mark

min

• min(that): Mark

• Returns this position, if its byte offset is less than or equal to that position; otherwise returns that position.

  Parameters

  • that: Mark

  Returns Mark

shift

• shift(mark): Mark

• Returns the position of this Tag relative to the given mark.

  Parameters

  • mark: Mark

  Returns Mark

toString

• toString(): string

• Returns string

union

• union(that): Tag

• Returns a Tag that includes all source locations covered by both this tag, and that tag.

  Parameters

  • that: Tag

  Returns Tag

withNote

• withNote(note): Mark

• Parameters

  • note: string

  Returns Mark

Static at

• at(offset, line, column, note?): Mark

• Returns a new Mark at the given zero-based byte offset, one-based line number, and one-based column number, with an optionally attached note.

  Parameters

  • offset: number

  • line: number

  • column: number

  • Optional note: string

  Returns Mark