ltxmlts
    Preparing search index...

    Class XmlParseError

    Error thrown by all parse/load methods when the input XML is malformed.

    Carries optional line, column, and file-path information to help locate the source of the error.

    try {
      XDocument.load('/data/config.xml');
    } catch (e) {
      if (e instanceof XmlParseError) {
        console.error(`Parse error in ${e.filePath} at line ${e.line}`);
      }
    }

    Hierarchy

    • Error
      • XmlParseError
    Index

    Constructors

    constructor

    Properties

    cause? column? filePath? line? message name stack? stackTraceLimit

    Methods

    captureStackTrace prepareStackTrace

    Constructors

    • Parameters

      • message: string

        The error message.

      • Optionalline: number

        The line number of the parse error.

      • Optionalcolumn: number

        The column number of the parse error.

      • OptionalfilePath: string

        The file path, if parsing from a file.

      Returns XmlParseError

    Properties

    cause?: unknown
    column?: number

    The 1-based column number where the error occurred, if available.

    filePath?: string

    The file path that was being parsed, if the parse originated from a file.

    line?: number

    The 1-based line number where the error occurred, if available.

    message: string
    name: string
    stack?: string
    stackTraceLimit: number

    The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

    The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

    If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

    Methods

    • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

      const myObject = {};
      Error.captureStackTrace(myObject);
      myObject.stack;  // Similar to `new Error().stack`

      The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

      The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

      The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

      function a() {
        b();
      }

      function b() {
        c();
      }

      function c() {
        // Create an error without stack trace to avoid calculating the stack trace twice.
        const { stackTraceLimit } = Error;
        Error.stackTraceLimit = 0;
        const error = new Error();
        Error.stackTraceLimit = stackTraceLimit;

        // Capture the stack trace above function b
        Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
        throw error;
      }

      a();

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods