Class XmlDocument

canonicalize

canonicalizeToString

Readonlywarnings

dtd

• get dtd(): XmlDtd | null

  Get the DTD of the document.

  Returns XmlDtd | null

  The DTD of the document, or null if the document has no DTD.

encoding

• get encoding(): string | null

  The actual encoding of the document, or null if not specified.

  Returns string | null

root

• get root(): XmlElement

  The root element of the document. If the document is newly created and hasn’t been set up with a root, an XmlError will be thrown.

  Returns XmlElement

• set root(value: XmlElement): void

  Set the root element of the document.

  Parameters

  • value: XmlElement

    The new root. If the node is from another document, it and its subtree will be removed from the previous document.

  Returns void

standalone

• get standalone(): number

  The standalone status of the document (indicator about external refs).

  1 if standalone="yes", 0 if standalone="no", -1 if there is no XML declaration, -2 if there is an XML declaration, but no standalone attribute was specified

  Returns number

version

• get version(): string

  The version string of the XML declaration.

  Returns string

createRoot

• createRoot(name: string, namespace?: string, prefix?: string): XmlElement

  Create the root element.

  Parameters

  • name: string

    The name of the root element.

  • Optionalnamespace: string

    The namespace of the root element.

  • Optionalprefix: string

    The prefix of the root node that represents the given namespace. If not provided, the given namespace will be the default.

  Returns XmlElement

eval

• eval(xpath: XmlXPath): string | number | boolean | XmlNode[]

  Evaluate the given XPath selector on the root element.

  Parameters

  • xpath: XmlXPath

    XPath selector

  Returns string | number | boolean | XmlNode[]

  See

  • XmlNode.get
  • XmlXPath.compile
  • get
  • find
• eval(
      xpath: string,
      namespaces?: NamespaceMap,
  ): string | number | boolean | XmlNode[]

  Evaluate the given XPath selector on the root element.

  Parameters

  • xpath: string

    XPath selector

  • Optionalnamespaces: NamespaceMap

  Returns string | number | boolean | XmlNode[]

  See

  • XmlNode.get
  • get
  • find

find

• find(xpath: XmlXPath): XmlNode[]

  Find all the descendant nodes of root element matching the given compiled xpath selector.

  Parameters

  • xpath: XmlXPath

    Compiled XPath selector

  Returns XmlNode[]

  An empty array if no nodes are found.

  See

  • XmlNode.find
  • get
  • eval
• find(xpath: string, namespaces?: NamespaceMap): XmlNode[]

  Find all the descendant nodes of root element matching the given xpath selector.

  Parameters

  • xpath: string

    XPath selector

  • Optionalnamespaces: NamespaceMap

    mapping between prefix and the namespace URI, used in the XPath

  Returns XmlNode[]

  An empty array if no nodes are found.

  See

  • XmlNode.find
  • get
  • eval

get

• get(xpath: XmlXPath): XmlNode | null

  Find the first descendant node of root element matching the given compiled xpath selector.

  Parameters

  • xpath: XmlXPath

    XPath selector

  Returns XmlNode | null

  null if not found, otherwise an instance of the subclass of XmlNode.

  See

  • XmlNode.get
  • XmlXPath.compile
  • find
  • eval
• get(xpath: string, namespaces?: NamespaceMap): XmlNode | null

  Find the first descendant node of root element matching the given xpath selector.

  Parameters

  • xpath: string

    XPath selector

  • Optionalnamespaces: NamespaceMap

    mapping between prefix and the namespace URI, used in the XPath

  Returns XmlNode | null

  null if not found, otherwise an instance of the subclass of XmlNode.

  See

  • XmlNode.get
  • find
  • eval

processXInclude

• processXInclude(): number

  Process the XInclude directives in the document synchronously.

  Returns number

  the number of XInclude nodes processed.

save

• save(handler: XmlOutputBufferHandler, options?: SaveOptions): void

  Save the XmlDocument to a buffer and invoke the callbacks to process.

  By default, it outputs with original encoding.

  Parameters

  • handler: XmlOutputBufferHandler

    handlers to process the content in the buffer

  • Optionaloptions: SaveOptions

    options to adjust the saving behavior

  Returns void

  See

  • toString
  • save

toBuffer

• toBuffer(handler: XmlOutputBufferHandler, options?: SaveOptions): void

  Save the XmlDocument to a buffer and invoke the callbacks to process.

  Parameters

  • handler: XmlOutputBufferHandler
  • Optionaloptions: SaveOptions

  Returns void

  Deprecated

  Use save instead.

toString

• toString(options?: SaveOptions): string

  Save the XmlDocument to a string

  By default, it outputs utf-8 encoded bytes, while ascii is another allowed option for options.encoding, which converts non-ascii characters into numeric character references.

  Parameters

  • Optionaloptions: SaveOptions

    options to adjust the saving behavior

  Returns string

  See

  • save
  • toString

Staticcreate

• create(): XmlDocument

  Create a new document from scratch. To parse an existing xml, use fromBuffer or fromString.

  Returns XmlDocument

StaticfromBuffer

• fromBuffer(source: Uint8Array, options?: ParseOptions): XmlDocument

  Parse and create an XmlDocument from an XML buffer.

  Parameters

  • source: Uint8Array

    The XML buffer

  • options: ParseOptions = {}

    Parsing options

  Returns XmlDocument

StaticfromString

• fromString(source: string, options?: ParseOptions): XmlDocument

  Parse and create an XmlDocument from an XML string.

  Note: Only UTF-8 encoding is supported for string input. For other encodings, use fromBuffer instead.

  Parameters

  • source: string

    The XML string

  • options: ParseOptions = {}

    Parsing options

  Returns XmlDocument

  Throws

  Error when encoding is not 'utf-8'