Document

The root node of the document.

Hierarchy

• NodeWithChildren
  • Document

Index

Constructors

• constructor

Properties

• children
• endIndex
• next
• parent
• prev
• sourceCodeLocation
• startIndex
• type
• x-mode

Accessors

• childNodes
• close
• firstChild
• lastChild
• loc
• nextSibling
• nodeType
• open
• parentNode
• previousSibling

Methods

• cloneNode

Constructors

constructor

• new Document(children: ChildNode[]): Document

• Inherited from NodeWithChildren.constructor

  Parameters

  • children: ChildNode[]

    Children of the node. Only certain node types can have children.

  Returns Document

Properties

publicchildren

children: ChildNode[]

Inherited from NodeWithChildren.children

Children of the node. Only certain node types can have children.

endIndex

endIndex: null | number = null

Inherited from NodeWithChildren.endIndex

The end index of the node. Requires withEndIndices on the handler to be `true.

next

next: null | ChildNode = null

Inherited from NodeWithChildren.next

Next sibling

parent

parent: null | ParentNode = null

Inherited from NodeWithChildren.parent

Parent of the node

prev

prev: null | ChildNode = null

Inherited from NodeWithChildren.prev

Previous sibling

optionalsourceCodeLocation

sourceCodeLocation?: null | SourceCodeLocation

Inherited from NodeWithChildren.sourceCodeLocation

parse5 source code location info.

Available if parsing with parse5 and location info is enabled.

startIndex

startIndex: null | number = null

Inherited from NodeWithChildren.startIndex

The start index of the node. Requires withStartIndices on the handler to be `true.

type

type: Root = ElementType.Root

Overrides NodeWithChildren.type

The type of the node.

optionalx-mode

x-mode?: no-quirks | quirks | limited-quirks

Document mode (parse5 only).

Accessors

childNodes

• get childNodes(): ChildNode[]
• set childNodes(children: ChildNode[]): void

• Inherited from NodeWithChildren.childNodes

  Same as children. DOM spec-compatible alias.

  ---

  Returns ChildNode[]

• Inherited from NodeWithChildren.childNodes

  Parameters

  • children: ChildNode[]

  Returns void

close

• get close(): undefined | CharValue
• set close(value: undefined | CharValue): void

• Inherited from NodeWithChildren.close

  Node close tag details. Can be null for self closing tag

  ---

  Returns undefined | CharValue

• Inherited from NodeWithChildren.close

  Parameters

  • value: undefined | CharValue

  Returns void

firstChild

• get firstChild(): null | ChildNode

• Inherited from NodeWithChildren.firstChild

  First child of the node.

  ---

  Returns null | ChildNode

lastChild

• get lastChild(): null | ChildNode

• Inherited from NodeWithChildren.lastChild

  Last child of the node.

  ---

  Returns null | ChildNode

loc

• get loc(): Range
• set loc(value: Range): void

• Inherited from NodeWithChildren.loc

  Node position in document

  ---

  Returns Range

• Inherited from NodeWithChildren.loc

  Parameters

  • value: Range

  Returns void

nextSibling

• get nextSibling(): null | ChildNode
• set nextSibling(next: null | ChildNode): void

• Inherited from NodeWithChildren.nextSibling

  Same as next. DOM spec-compatible alias.

  ---

  Returns null | ChildNode

• Inherited from NodeWithChildren.nextSibling

  Parameters

  • next: null | ChildNode

  Returns void

nodeType

• get nodeType(): 9

• Overrides NodeWithChildren.nodeType

  DOM spec-compatible node type.

  ---

  Returns 9

open

• get open(): CharValue
• set open(value: CharValue): void

• Inherited from NodeWithChildren.open

  Node open tag details

  ---

  Returns CharValue

• Inherited from NodeWithChildren.open

  Parameters

  • value: CharValue

  Returns void

parentNode

• get parentNode(): null | ParentNode
• set parentNode(parent: null | ParentNode): void

• Inherited from NodeWithChildren.parentNode

  Same as parent. DOM spec-compatible alias.

  ---

  Returns null | ParentNode

• Inherited from NodeWithChildren.parentNode

  Parameters

  • parent: null | ParentNode

  Returns void

previousSibling

• get previousSibling(): null | ChildNode
• set previousSibling(prev: null | ChildNode): void

• Inherited from NodeWithChildren.previousSibling

  Same as prev. DOM spec-compatible alias.

  ---

  Returns null | ChildNode

• Inherited from NodeWithChildren.previousSibling

  Parameters

  • prev: null | ChildNode

  Returns void

Methods

cloneNode

• cloneNode<T>(this: T, recursive?: boolean): T

• Inherited from NodeWithChildren.cloneNode

  Clone this node, and optionally its children.

  ---

  Type parameters

  • T: Node

  Parameters

  • this: T

  • recursive: boolean = false

    Clone child nodes as well.

  Returns T

  A clone of the node.