Class XMLDocument

Hierarchy

XMLReference<xmlDocPtr>
- XMLDocument
  - HTMLDocument

Properties

errors

errors: XMLStructuredError[]

validationErrors

validationErrors: any[]

Methods

child

child(index: number): null | XMLElement
See
XMLNode.child
Parameters
- index: number
Returns null | XMLElement
- Defined in lib/document.ts:231

childNodes

childNodes(): XMLElement[]
See
XMLNode.childNodes

Returns XMLElement[]
- Defined in lib/document.ts:192

createComment

createComment(content?: string): XMLText
Parameters
- Optional content: string
Returns XMLText
- Defined in lib/document.ts:128

createElement

createElement(name: string, content?: string): XMLElement
Parameters
- name: string
- content: string = ""
Returns XMLElement
- Defined in lib/document.ts:354

createProcessingInstruction

createProcessingInstruction(name: string, content?: string): XMLText
Parameters
- name: string
- Optional content: string
Returns XMLText
- Defined in lib/document.ts:136

createText

createText(content?: string, encode?: boolean): XMLText
Parameters
- Optional content: string
- encode: boolean = true
Returns XMLText
- Defined in lib/document.ts:120

doc

doc(): XMLDocument
See
XMLNode.doc

Returns XMLDocument
- Defined in lib/document.ts:185

encode

encode(data: string): string
Parameters
- data: string
Returns string
- Defined in lib/document.ts:343

encoding

encoding(value?: string): string
Parameters
- Optional value: string
Returns string
- Defined in lib/document.ts:413

find

find(xpath: string, namespace?: XPathNamespace): XMLXPathNode[]
See
XMLNode.find
Parameters
- xpath: string
- Optional namespace: XPathNamespace
Returns XMLXPathNode[]
- Defined in lib/document.ts:205

fromHtml

fromHtml(buffer: string, options?: HTMLParseOptions): HTMLDocument
Parameters
- buffer: string
- options: HTMLParseOptions = DEFAULT_HTML_PARSE_OPTIONS
Returns HTMLDocument
- Defined in lib/document.ts:391

fromXml

fromXml(buffer: string, options?: XMLParseOptions): HTMLDocument
Parameters
- buffer: string
- options: XMLParseOptions = DEFAULT_XML_PARSE_OPTIONS
Returns HTMLDocument
- Defined in lib/document.ts:399

get

get(xpath: string, namespace?: XPathNamespace): null | string | number | boolean | XMLXPathNode
see XMLNode.get
Parameters
- xpath: string
- Optional namespace: XPathNamespace
Returns null | string | number | boolean | XMLXPathNode
- Defined in lib/document.ts:218

getDtd

getDtd(): null | XMLDTD
Returns null | XMLDTD
- Defined in lib/document.ts:369

getParseFlags

getParseFlags(): number
Returns number
- Defined in lib/document.ts:423

name

name(): string
Returns string
- Defined in lib/document.ts:329

namespaces

namespaces(): XMLNamespace[]
Returns XMLNamespace[]
- Defined in lib/document.ts:241

node

node(name: string, content?: string): XMLElement
Parameters
- name: string
- Optional content: string
Returns XMLElement
- Defined in lib/document.ts:333

rngValidate

rngValidate(schemaDoc: XMLDocument): boolean
Parameters
- schemaDoc: XMLDocument
Returns boolean
- Defined in lib/document.ts:293

root

root(node?: XMLElement): null | XMLElement
Get or set the document root

Returns
the root node for the document
Parameters
- Optional node: XMLElement
  
  the node to set as the document root
Returns null | XMLElement
- Defined in lib/document.ts:172

setDtd

setDtd(name: string, externalId?: null | string, systemId?: null | string): null | XMLDTD
Parameters
- name: string
- externalId: null | string = null
- systemId: null | string = null
Returns null | XMLDTD
- Defined in lib/document.ts:375

toString

toString(options?: boolean | XMLSaveOptions): string
Parameters
- options: boolean | XMLSaveOptions = DEFAULT_XML_SAVE_OPTIONS
Returns string
- Defined in lib/document.ts:431

type

type(): string
Returns string
- Defined in lib/document.ts:427

validate

validate(schemaDoc: XMLDocument): unknown
Validate the current document against the given schema

Returns
valid
Parameters
- schemaDoc: XMLDocument
  
  document to validate against
Returns unknown
- Defined in lib/document.ts:257

version

version(): null | string
Returns null | string
- Defined in lib/document.ts:407

`Static` fromHtml

fromHtml(buffer: string | Buffer, options?: HTMLParseOptions): HTMLDocument
Parameters
- buffer: string | Buffer
- Optional options: HTMLParseOptions
Returns HTMLDocument
- Defined in lib/document.ts:521

`Static` fromHtmlAsync

fromHtmlAsync(buffer: string | Buffer, options?: HTMLParseOptions): Promise<HTMLDocument>
Parameters
- buffer: string | Buffer
- options: HTMLParseOptions = DEFAULT_HTML_PARSE_OPTIONS
Returns Promise<HTMLDocument>
- Defined in lib/document.ts:525

`Static` fromHtmlFragment

fromHtmlFragment(buffer: string, options?: HTMLParseOptions): HTMLDocument
Parameters
- buffer: string
- Optional options: HTMLParseOptions
Returns HTMLDocument
- Defined in lib/document.ts:532

`Static` fromXml

fromXml(buffer: string | Buffer, options?: XMLParseOptions): XMLDocument
Parameters
- buffer: string | Buffer
- Optional options: XMLParseOptions
Returns XMLDocument
- Defined in lib/document.ts:510

`Static` fromXmlAsync

fromXmlAsync(buffer: string | Buffer, options?: XMLParseOptions): Promise<XMLDocument>
Parameters
- buffer: string | Buffer
- options: XMLParseOptions = DEFAULT_XML_PARSE_OPTIONS
Returns Promise<XMLDocument>
- Defined in lib/document.ts:514

`Static` toString

toString(node: XMLNode | XMLDocument, options?: boolean | XMLSaveOptions): string
Parameters
- node: XMLNode | XMLDocument
- options: boolean | XMLSaveOptions = {}
Returns string
- Defined in lib/document.ts:445

Generated using TypeDoc