Comment

Comments within the document.

Hierarchy

• DataNode
  • Comment

Index

Constructors

• constructor

Properties

• children
• data
• endIndex
• next
• parent
• prev
• sourceCodeLocation
• startIndex
• type

Accessors

• close
• loc
• nextSibling
• nodeType
• nodeValue
• open
• parentNode
• previousSibling

Methods

• cloneNode

Constructors

constructor

• new Comment(data: string): Comment

• Inherited from DataNode.constructor

  Parameters

  • data: string

    The content of the data node

  Returns Comment

Properties

children

children: Node[] = []

Inherited from DataNode.children

publicdata

data: string

Inherited from DataNode.data

The content of the data node

endIndex

endIndex: null | number = null

Inherited from DataNode.endIndex

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

next

next: null | ChildNode = null

Inherited from DataNode.next

Next sibling

parent

parent: null | ParentNode = null

Inherited from DataNode.parent

Parent of the node

prev

prev: null | ChildNode = null

Inherited from DataNode.prev

Previous sibling

optionalsourceCodeLocation

sourceCodeLocation?: null | SourceCodeLocation

Inherited from DataNode.sourceCodeLocation

parse5 source code location info.

Available if parsing with parse5 and location info is enabled.

startIndex

startIndex: null | number = null

Inherited from DataNode.startIndex

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

type

type: Comment = ElementType.Comment

Overrides DataNode.type

The type of the node.

Accessors

close

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

• Inherited from DataNode.close

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

  ---

  Returns undefined | CharValue

• Inherited from DataNode.close

  Parameters

  • value: undefined | CharValue

  Returns void

loc

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

• Inherited from DataNode.loc

  Node position in document

  ---

  Returns Range

• Inherited from DataNode.loc

  Parameters

  • value: Range

  Returns void

nextSibling

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

• Inherited from DataNode.nextSibling

  Same as next. DOM spec-compatible alias.

  ---

  Returns null | ChildNode

• Inherited from DataNode.nextSibling

  Parameters

  • next: null | ChildNode

  Returns void

nodeType

• get nodeType(): 8

• Overrides DataNode.nodeType

  DOM spec-compatible node type.

  ---

  Returns 8

nodeValue

• get nodeValue(): string
• set nodeValue(data: string): void

• Inherited from DataNode.nodeValue

  Same as data. DOM spec-compatible alias.

  ---

  Returns string

• Inherited from DataNode.nodeValue

  Parameters

  • data: string

  Returns void

open

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

• Inherited from DataNode.open

  Node open tag details

  ---

  Returns CharValue

• Inherited from DataNode.open

  Parameters

  • value: CharValue

  Returns void

parentNode

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

• Inherited from DataNode.parentNode

  Same as parent. DOM spec-compatible alias.

  ---

  Returns null | ParentNode

• Inherited from DataNode.parentNode

  Parameters

  • parent: null | ParentNode

  Returns void

previousSibling

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

• Inherited from DataNode.previousSibling

  Same as prev. DOM spec-compatible alias.

  ---

  Returns null | ChildNode

• Inherited from DataNode.previousSibling

  Parameters

  • prev: null | ChildNode

  Returns void

Methods

cloneNode

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

• Inherited from DataNode.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.