YAMLParseError

Defined in: src/index.ts:157

Thrown by parse / parseAll when the input is not well-formed YAML (or violates a parse constraint). The message includes the 1-based line and column of the problem, rendered as … (line L, column C).

Example

try {
  parse("items: [1, 2");
} catch (err) {
  if (err instanceof YAMLParseError) console.error(err.message);
}

Extends

• Error

Constructors

Constructor

new YAMLParseError(message): YAMLParseError

Defined in: src/index.ts:158

Parameters

message

string

Returns

YAMLParseError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Defined in: site/node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

---

message

message: string

Defined in: site/node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

---

name

name: string

Defined in: site/node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

---

stack?

optional stack?: string

Defined in: site/node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack