parse() — API reference

parse

function parse(xml: string, options?: ParseOptions): DMNModel

Parses a DMN XML string. Throws Error on malformed XML or missing <definitions>.

Parameters

Name	Type	Description
xml	string	DMN XML content
options	ParseOptions	Optional configuration

Returns DMNModel

---

safeParse

function safeParse(xml: string, options?: ParseOptions): ParseResult

Never throws. Returns a discriminated union result.

---

detectVersion

function detectVersion(xml: string): DMNVersion

Lightweight version detection — does not build a full model.

---

serialize

function serialize(model: DMNModel): string

Produces minimal valid XML from a DMNModel. Useful for dmn-fmt.

---

ParseOptions

interface ParseOptions {
  includeDMNDI?: boolean
  strict?: boolean
  version?: DMNVersion
}

---

ParseResult

type ParseResult =
  | { success: true;  model: DMNModel; warnings: ParseWarning[] }
  | { success: false; errors: ParseError[];  warnings: ParseWarning[] }

---

ParseError / ParseWarning

interface ParseError   { code: string; message: string; path?: string }
interface ParseWarning { code: string; message: string; path?: string }