pHTML

Constructor

new Comment(settings)

Source:

Comment.js, line 12

Example

new Comment({ comment: ' Hello World ' }) // <!-- Hello -->

Parameters:

Name	Type	Description
`settings`	CommentSettings \| string	Custom settings applied to the Comment, or the content of the Comment.

Extends

Node

Members

comment :string

Source:

Comment.js, line 29

Content of the Comment

Type:

string

index

Source:

Node.js, line 11

Overrides:

Node#index

Position of the current Node from its parent.

Example

node.index // returns the index of the node or -1

innerHTML

Source:

Comment.js, line 40

Return the stringified innerHTML of the current Comment.

Example

attrs.innerHTML // returns ' Hello World '

name :'#comment'

Source:

Comment.js, line 25

Node name of the Comment

Type:

'#comment'

Source:

Node.js, line 25

Overrides:

Node#next

Next Node after the current Node, or null if there is none.

Example

node.next // returns null

nextElement

Source:

Node.js, line 41

Overrides:

Node#nextElement

Next Element after the current Node, or null if there is none.

Example

node.nextElement // returns an element or null

outerHTML

Source:

Comment.js, line 48

Return the stringified outerHTML of the current Comment.

Example

attrs.outerHTML // returns '<!-- Hello World -->'

Source:

Node.js, line 57

Overrides:

Node#previous

Previous Node before the current Node, or null if there is none.

Example

node.previous // returns a node or null

previousElement

Source:

Node.js, line 73

Overrides:

Node#previousElement

Previous Element before the current Node, or null if there is none.

Example

node.previousElement // returns an element or null

root

Source:

Node.js, line 89

Overrides:

Node#root

Top-most ancestor from the current Node.

Example

node.root // returns the top-most node or the current node itself

source :CommentSource

Source:

Comment.js, line 33

Source mapping of the Content

Type:

CommentSource

sourceInnerHTML

Source:

Comment.js, line 56

Return the stringified innerHTML from the source input.

Example

attrs.sourceInnerHTML // returns ' Hello World '

sourceOuterHTML

Source:

Comment.js, line 69

Return the stringified outerHTML from the source input.

Example

attrs.sourceOuterHTML // returns '<!-- Hello World -->'

type :'comment'

Source:

Comment.js, line 21

Type identifier of the Comment

Type:

'comment'

Methods

after(…nodes)

Source:

Node.js, line 105

Overrides:

Node#after

Insert one or more Nodes after the current Node, returning the current Node.

Example

node.after(new Text({ data: 'Hello World' }))

Parameters:

Name	Type	Attributes	Description
`nodes`	Node \| string	<repeatable>	Any nodes to be inserted after the current Node.

append(…nodes)

Source:

Node.js, line 123

Overrides:

Node#append

Append Nodes or new Text Nodes to the current Node, returning the current Node.

Example

node.append(someOtherNode)

Parameters:

Name	Type	Attributes	Description
`nodes`	Node \| string	<repeatable>	Any nodes to be inserted after the last child of the current Node.

appendTo(parent)

Source:

Node.js, line 135

Overrides:

Node#appendTo

Append the current Node to another Node, returning the current Node.

Parameters:

Name	Type	Description
`parent`	Container	Container for the current Node.

before(…nodes)

Source:

Node.js, line 149

Overrides:

Node#before

Insert Nodes or new Text Nodes before the Node if it has a parent, returning the current Node.

Example

node.before(new Text({ data: 'Hello World' })) // returns the current node

Parameters:

Name	Type	Attributes	Description
`nodes`	Node \| string	<repeatable>	Any nodes to be inserted before the current Node.

clone(settings) → {Comment}

Source:

Comment.js, line 86

Return a clone of the current Comment.

Examples

comment.clone()

Clone the current text with new source.

comment.clone({ source: { input: { html: 'modified source' } } })

Parameters:

Name	Type	Description
`settings`	Object	Custom settings applied to the cloned Comment.

Returns:

Type: Comment

prepend(…nodes)

Source:

Node.js, line 167

Overrides:

Node#prepend

Prepend Nodes or new Text Nodes to the current Node, returning the current Node.

Example

node.prepend(someOtherNode)

Parameters:

Name	Type	Attributes	Description
`nodes`	Node \| string	<repeatable>	Any nodes inserted before the first child of the current Node.

remove()

Source:

Node.js, line 180

Overrides:

Node#remove

Remove the current Node from its parent, returning the current Node.

Example

node.remove() // returns the current node

replaceWith(…nodes)

Source:

Node.js, line 196

Overrides:

Node#replaceWith

Replace the current Node with another Node or Nodes, returning the current Node.

Example

node.replaceWith(someOtherNode) // returns the current node

Parameters:

Name	Type	Attributes	Description
`nodes`	Node	<repeatable>	Any nodes replacing the current Node.

toJSON()

Source:

Comment.js, line 104

Return the current Comment as a Object.

Example

attrs.toJSON() // returns { comment: ' Hello World ' }

toString()

Source:

Comment.js, line 96

Return the current Comment as a String.

Example

attrs.toJSON() // returns '<!-- Hello World -->'

visit(result, overrideVisitorsopt) → {ResultPromise}

Source:

Node.js, line 222

Overrides:

Node#visit

Transform the current Node and any descendants using visitors.

Examples

await node.visit(result)

await node.visit() // visit using the result of the current node

await node.visit(result, {
  Element () {
    // do something to an element
  }
})

Parameters:

Name	Type	Attributes	Description
`result`	Result		Result to be used by visitors.
`overrideVisitors`	Object	<optional>	Alternative visitors to be used in place of Result visitors.

Returns:

Type: ResultPromise

warn(result, text, optsopt)

Source:

Node.js, line 241

Overrides:

Node#warn

Add a warning from the current Node.

Examples

node.warn(result, 'Something went wrong')

node.warn(result, 'Something went wrong', {
  node: someOtherNode,
  plugin: someOtherPlugin
})

Parameters:

Name	Type	Attributes	Description
`result`	Result		Result the warning is being added to.
`text`	string		Message being sent as the warning.
`opts`	Object	<optional>	Additional information about the warning.