XmlSyntaxError

Example: Usage

import { XmlSyntaxError } from "@ende/xml/types";
import { assertInstanceOf } from "@ende/assert";

const error = new XmlSyntaxError("Unexpected character", { line: 10, column: 5, offset: 150 });
assertInstanceOf(error, SyntaxError);

constructor

new XmlSyntaxError(message: string, position: XmlPosition)

Constructs a new XmlSyntaxError.

The position is appended to the message, unless position.line is 0 (the sentinel used when position tracking is disabled).

message: string

The error message describing the syntax issue.

position: XmlPosition

The position in the XML source where the error occurred.

line

readonly line: number

The line number where the error occurred (1-indexed), or 0 when position tracking is disabled.

import { XmlSyntaxError } from "@ende/xml/types";
import { assertEquals } from "@ende/assert";

const error = new XmlSyntaxError("Test", { line: 5, column: 10, offset: 50 });
assertEquals(error.line, 5);

column

readonly column: number

The column number where the error occurred (1-indexed), or 0 when position tracking is disabled.

import { XmlSyntaxError } from "@ende/xml/types";
import { assertEquals } from "@ende/assert";

const error = new XmlSyntaxError("Test", { line: 5, column: 10, offset: 50 });
assertEquals(error.column, 10);

offset

readonly offset: number

The character offset in the input string where the error occurred (in UTF-16 code units, 0-indexed).

import { XmlSyntaxError } from "@ende/xml/types";
import { assertEquals } from "@ende/assert";

const error = new XmlSyntaxError("Test", { line: 5, column: 10, offset: 50 });
assertEquals(error.offset, 50);