Class XMLDocument

errors

validationErrors

child

• child(index: number): XMLElement | null

  Parameters

  • index: number

  Returns XMLElement | null

  See

  XMLNode.child

childNodes

• childNodes(): XMLElement[]

  Returns XMLElement[]

  See

  XMLNode.childNodes

createComment

• createComment(content?: string): XMLText

  Parameters

  • Optionalcontent: string

  Returns XMLText

createElement

• createElement(name: string, content?: string): XMLElement

  Parameters

  • name: string
  • content: string = ""

  Returns XMLElement

createProcessingInstruction

• createProcessingInstruction(name: string, content?: string): XMLText

  Parameters

  • name: string
  • Optionalcontent: string

  Returns XMLText

createText

• createText(content?: string, encode?: boolean): XMLText

  Parameters

  • Optionalcontent: string
  • encode: boolean = true

  Returns XMLText

doc

• doc(): XMLDocument

  Returns XMLDocument

  See

  XMLNode.doc

encode

• encode(data: string): string

  Parameters

  • data: string

  Returns string

encoding

• encoding(value?: string): string

  Parameters

  • Optionalvalue: string

  Returns string

find

• find(xpath: string, namespace?: XPathNamespace): XMLXPathNode[]

  Parameters

  • xpath: string
  • Optionalnamespace: XPathNamespace

  Returns XMLXPathNode[]

  See

  XMLNode.find

fromHtml

• fromHtml(buffer: string, options?: HTMLParseOptions): HTMLDocument

  Parameters

  • buffer: string
  • options: HTMLParseOptions = DEFAULT_HTML_PARSE_OPTIONS

  Returns HTMLDocument

fromXml

• fromXml(buffer: string, options?: XMLParseOptions): HTMLDocument

  Parameters

  • buffer: string
  • options: XMLParseOptions = DEFAULT_XML_PARSE_OPTIONS

  Returns HTMLDocument

get

• get(
      xpath: string,
      namespace?: XPathNamespace,
  ): string | number | boolean | XMLXPathNode | null

  see XMLNode.get

  Parameters

  • xpath: string
  • Optionalnamespace: XPathNamespace

  Returns string | number | boolean | XMLXPathNode | null

getDtd

• getDtd(): XMLDTD | null

  Returns XMLDTD | null

getParseFlags

• getParseFlags(): number

  Returns number

name

• name(): string

  Returns string

namespaces

• namespaces(): XMLNamespace[]

  Returns XMLNamespace[]

node

• node(name: string, content?: string): XMLElement

  Parameters

  • name: string
  • Optionalcontent: string

  Returns XMLElement

rngValidate

• rngValidate(schemaDoc: XMLDocument): boolean

  Parameters

  • schemaDoc: XMLDocument

  Returns boolean

root

• root(node?: XMLElement): XMLElement | null

  Get or set the document root

  Parameters

  • Optionalnode: XMLElement

    the node to set as the document root

  Returns XMLElement | null

  the root node for the document

setDtd

• setDtd(
      name: string,
      externalId?: string | null,
      systemId?: string | null,
  ): XMLDTD | null

  Parameters

  • name: string
  • externalId: string | null = null
  • systemId: string | null = null

  Returns XMLDTD | null

toString

• toString(options?: boolean | XMLSaveOptions): string

  Returns a string representation of an object.

  Parameters

  • options: boolean | XMLSaveOptions = DEFAULT_XML_SAVE_OPTIONS

  Returns string

type

• type(): string

  Returns string

validate

• validate(schemaDoc: XMLDocument): unknown

  Validate the current document against the given schema

  Parameters

  • schemaDoc: XMLDocument

    document to validate against

  Returns unknown

  valid

version

• version(): string | null

  Returns string | null

StaticfromHtml

• fromHtml(
      buffer: string | Buffer<ArrayBufferLike>,
      options?: HTMLParseOptions,
  ): HTMLDocument

  Parameters

  • buffer: string | Buffer<ArrayBufferLike>
  • Optionaloptions: HTMLParseOptions

  Returns HTMLDocument

StaticfromHtmlAsync

• fromHtmlAsync(
      buffer: string | Buffer<ArrayBufferLike>,
      options?: HTMLParseOptions,
  ): Promise<HTMLDocument>

  Parameters

  • buffer: string | Buffer<ArrayBufferLike>
  • options: HTMLParseOptions = DEFAULT_HTML_PARSE_OPTIONS

  Returns Promise<HTMLDocument>

StaticfromHtmlFragment

• fromHtmlFragment(buffer: string, options?: HTMLParseOptions): HTMLDocument

  Parameters

  • buffer: string
  • Optionaloptions: HTMLParseOptions

  Returns HTMLDocument

StaticfromXml

• fromXml(
      buffer: string | Buffer<ArrayBufferLike>,
      options?: XMLParseOptions,
  ): XMLDocument

  Parameters

  • buffer: string | Buffer<ArrayBufferLike>
  • Optionaloptions: XMLParseOptions

  Returns XMLDocument

StaticfromXmlAsync

• fromXmlAsync(
      buffer: string | Buffer<ArrayBufferLike>,
      options?: XMLParseOptions,
  ): Promise<XMLDocument>

  Parameters

  • buffer: string | Buffer<ArrayBufferLike>
  • options: XMLParseOptions = DEFAULT_XML_PARSE_OPTIONS

  Returns Promise<XMLDocument>

StatictoString

• toString(
      node: XMLNode | XMLDocument,
      options?: boolean | XMLSaveOptions,
  ): string

  Returns a string representation of a function.

  Parameters

  • node: XMLNode | XMLDocument
  • options: boolean | XMLSaveOptions = {}

  Returns string