Class XMLElement

Hierarchy (View Summary)

XMLNode
- XMLElement

Methods

addChild

addChild(node: XMLElement): XMLElement
Append node after the last node child
Parameters
- node: XMLElement
  the XMLElement to append
Returns XMLElement
the appended child
Inherited from XMLNode.addChild
- Defined in lib/node.ts:337

addNextSibling

addNextSibling(node: XMLElement): XMLElement | null
Insert a node directly after the current node
Parameters
- node: XMLElement
  the node to be inserted
Returns XMLElement | null
the inserted sibling
Inherited from XMLNode.addNextSibling
- Defined in lib/node.ts:370

addPrevSibling

addPrevSibling(node: XMLElement): XMLElement
Insert a node directly before the current node
Parameters
- node: XMLElement
  the node to be inserted
Returns XMLElement
the inserted sibling
Inherited from XMLNode.addPrevSibling
- Defined in lib/node.ts:401

attr

attr(attributes: XMLAttributeMap): XMLElement
set multiple attributes BREAKING CHANGE: no longer overloaded for setting single attr
Parameters
- attributes: XMLAttributeMap
Returns XMLElement
- Defined in lib/node.ts:666

attrs

attrs(): XMLAttribute[]
Returns XMLAttribute[]
- Defined in lib/node.ts:678

cdata

cdata(content: string): XMLElement
Parameters
- content: string
Returns XMLElement
- Defined in lib/node.ts:693

child

child(index: number): XMLElement | null
Return the child at the given index
Parameters
- index: number
  the index of the child
Returns XMLElement | null
the child to return
Inherited from XMLNode.child
- Defined in lib/node.ts:531

childNodes

childNodes(): XMLElement[]
Get an array of child nodes

Returns XMLElement[]
array of child nodes
Inherited from XMLNode.childNodes
- Defined in lib/node.ts:418

clone

clone(): XMLNode | XMLAttribute | XMLElement | XMLDocument | null
Returns XMLNode | XMLAttribute | XMLElement | XMLDocument | null
Inherited from XMLNode.clone
- Defined in lib/node.ts:625

createElement

createElement(name: string, content?: string): XMLElement
Create a new element with the given name and content
Parameters
- name: string
- Optionalcontent: string
Returns XMLElement
the created element
Inherited from XMLNode.createElement
- Defined in lib/node.ts:241

defineNamespace

defineNamespace(prefix: string | null, href?: string | null): XMLNamespace
Parameters
- prefix: string | null
- Optionalhref: string | null
Returns XMLNamespace
Inherited from XMLNode.defineNamespace
- Defined in lib/node.ts:254

doc

doc(): XMLDocument | null
Get the associated XMLDocument for the current node

Returns XMLDocument | null
Inherited from XMLNode.doc
- Defined in lib/node.ts:557

evaluateXPath

evaluateXPath(xpath: string, namespace?: XPathNamespace): xmlXPathObjectPtr
Parameters
- xpath: string
- Optionalnamespace: XPathNamespace
Returns xmlXPathObjectPtr
Inherited from XMLNode.evaluateXPath
- Defined in lib/node.ts:440

find

find(xpath: string, namespace?: XPathNamespace): XMLXPathNode[]
Find decendant nodes matching the given xpath selector
Parameters
- xpath: string
  XPath selector
- Optionalnamespace: XPathNamespace
  optional namespace
Returns XMLXPathNode[]
array of matching decendant nodes
Inherited from XMLNode.find
- Defined in lib/node.ts:473

get

get(
xpath: string,
namespace?: XPathNamespace,
): string | number | boolean | XMLXPathNode | null
Find the first decendant node matching the given xpath selector
Parameters
- xpath: string
  XPath selector
- Optionalnamespace: XPathNamespace
  optional namespace
Returns string | number | boolean | XMLXPathNode | null
first matching decendant node
Inherited from XMLNode.get
- Defined in lib/node.ts:498

getAttribute

getAttribute(key: string): XMLAttribute | null
Parameters
- key: string
Returns XMLAttribute | null
- Defined in lib/node.ts:648

`Protected`importNode

importNode(node: xmlNodePtr): XMLNode
Parameters
- node: xmlNodePtr
Returns XMLNode
Inherited from XMLNode.importNode
- Defined in lib/node.ts:305

line

line(): number
Get the line number that this node starts on in the original parsed document

Returns number
line number
Inherited from XMLNode.line
- Defined in lib/node.ts:157

name

name(value?: string): string
Get the tag name of current node
Parameters
- Optionalvalue: string
Returns string
name
Overrides XMLNode.name
- Defined in lib/node.ts:640

namespace

namespace(
prefix?: string | XMLNamespace | null,
href?: string | null,
): XMLNamespace | null
Get or set the namespace for the current node
Parameters
- Optionalprefix: string | XMLNamespace | null
  namespace prefix
- Optionalhref: string | null
  namespace URL
Returns XMLNamespace | null
the current namespace
Inherited from XMLNode.namespace
- Defined in lib/node.ts:574

namespaces

namespaces(onlyLocal?: boolean): XMLNamespace[]
Get an array of namespaces that appy to the current node
Parameters
- onlyLocal: boolean = false
  whether to include inherited namespaces
Returns XMLNamespace[]
an array of namespaces for the current node
Inherited from XMLNode.namespaces
- Defined in lib/node.ts:603

nextElement

nextElement(): XMLNode | null
Get the next sibling relative to the current node

Returns XMLNode | null
next element
Inherited from XMLNode.nextElement
- Defined in lib/node.ts:295

nextSibling

nextSibling(): XMLNode | null
Returns XMLNode | null
Inherited from XMLNode.nextSibling
- Defined in lib/node.ts:436

node

node(name: string, content?: string): XMLElement
Create a new element with the given name and content, then append it as a child of the current node
Parameters
- name: string
- Optionalcontent: string
Returns XMLElement
the appended element

See
XMLNode.createElement
Inherited from XMLNode.node
- Defined in lib/node.ts:230

parent

parent(): XMLNode | XMLAttribute | XMLElement | XMLDocument | null
Get the parent node for the current

Returns XMLNode | XMLAttribute | XMLElement | XMLDocument | null
parent node
Inherited from XMLNode.parent
- Defined in lib/node.ts:111

path

path(): string
Returns string
- Defined in lib/node.ts:725

prevElement

prevElement(): XMLNode | null
Get the previous sibling relative to the current node

Returns XMLNode | null
previous element
Inherited from XMLNode.prevElement
- Defined in lib/node.ts:280

prevSibling

prevSibling(): XMLNode | null
Returns XMLNode | null
Inherited from XMLNode.prevSibling
- Defined in lib/node.ts:432

remove

remove(): void
Returns void
Inherited from XMLNode.remove
- Defined in lib/node.ts:548

replace

replace(value: string | XMLElement): void
Parameters
- value: string | XMLElement
Returns void
- Defined in lib/node.ts:729

setAttribute

setAttribute(key: string, value: string | number): XMLAttribute | null
Parameters
- key: string
- value: string | number
Returns XMLAttribute | null
- Defined in lib/node.ts:654

text

text(content?: string): string
Parameters
- Optionalcontent: string
Returns string
- Defined in lib/node.ts:703

toString

toString(options?: boolean | XMLSaveOptions): string
Returns a string representation of an object.
Parameters
- options: boolean | XMLSaveOptions = {}
Returns string
Inherited from XMLNode.toString
- Defined in lib/node.ts:563

type

type(): | "document"
| "text"
| "node"
| "element"
| "attribute"
| "cdata"
| "entity_ref"
| "entity"
| "pi"
| "comment"
| "document_type"
| "document_frag"
| "notation"
| "html_document"
| "dtd"
| "element_decl"
| "attribute_decl"
| "entity_decl"
| "namespace_decl"
| "xinclude_start"
| "xinclude_end"
| "docb_document"
Get the type of element (XMLElementType)

"text" | "cdata" | "comment" | "element" | "node"

Returns
    | "document"
    | "text"
    | "node"
    | "element"
    | "attribute"
    | "cdata"
    | "entity_ref"
    | "entity"
    | "pi"
    | "comment"
    | "document_type"
    | "document_frag"
    | "notation"
    | "html_document"
    | "dtd"
    | "element_decl"
    | "attribute_decl"
    | "entity_decl"
    | "namespace_decl"
    | "xinclude_start"
    | "xinclude_end"
    | "docb_document"
the node type
Inherited from XMLNode.type
- Defined in lib/node.ts:170

Class XMLElement

Hierarchy (View Summary)

Index

Methods

Methods

addChild

Parameters

Returns XMLElement

addNextSibling

Parameters

Returns XMLElement | null

addPrevSibling

Parameters

Returns XMLElement

attr

Parameters

Returns XMLElement

attrs

Returns XMLAttribute[]

cdata

Parameters

Returns XMLElement

child

Parameters

Returns XMLElement | null

childNodes

Returns XMLElement[]

clone

Returns XMLNode | XMLAttribute | XMLElement | XMLDocument | null

createElement

Parameters

Returns XMLElement

defineNamespace

Parameters

Returns XMLNamespace

doc

Returns XMLDocument | null

evaluateXPath

Parameters

Returns xmlXPathObjectPtr

find

Parameters

Returns XMLXPathNode[]

get

Parameters

Returns string | number | boolean | XMLXPathNode | null

getAttribute

Parameters

Returns XMLAttribute | null

ProtectedimportNode

Parameters

Returns XMLNode

line

Returns number

name

Parameters

Returns string

namespace

Parameters

Returns XMLNamespace | null

namespaces

Parameters

Returns XMLNamespace[]

nextElement

Returns XMLNode | null

nextSibling

Returns XMLNode | null

node

Parameters

Returns XMLElement

See

parent

Returns XMLNode | XMLAttribute | XMLElement | XMLDocument | null

path

Returns string

prevElement

Returns XMLNode | null

prevSibling

Returns XMLNode | null

remove

`Protected`importNode