pHTML

Constructor

new Container()

Source:

Container.js, line 6

Extends

Node

Members

elements

Source:

Container.js, line 53

Return a child Element NodeList of the current Container.

Example

container.elements // returns an array of Elements

first

Source:

Container.js, line 13

Return the first child Node of the current Container, or null if there is none.

Example

container.first // returns a Node or null

firstElement

Source:

Container.js, line 23

Return the first child Element of the current Container, or null if there is none.

Example

container.firstElement // returns an Element or null

index

Source:

Node.js, line 11

Inherited From:

Node#index

Position of the current Node from its parent.

Example

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

innerHTML

Source:

Container.js, line 62

Return the innerHTML of the current Container as a String.

Example

container.innerHTML // returns a string of innerHTML

innerHTML

Source:

Container.js, line 74

Define the nodes of the current Container from a String.

Example

container.innerHTML = 'Hello <strong>world</strong>';
container.nodes.length; // 2

last

Source:

Container.js, line 33

Return the last child Node of the current Container, or null if there is none.

Example

container.last // returns a Node or null

lastElement

Source:

Container.js, line 43

Return the last child Element of the current Container, or null if there is none.

Example

container.lastElement // returns an Element or null

Source:

Node.js, line 25

Inherited From:

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

Inherited From:

Node#nextElement

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

Example

node.nextElement // returns an element or null

outerHTML

Source:

Container.js, line 84

Return the outerHTML of the current Container as a String.

Example

container.outerHTML // returns a string of outerHTML

outerHTML

Source:

Container.js, line 95

Replace the current Container from a String.

Example

container.outerHTML = 'Hello <strong>world</strong>';

Source:

Node.js, line 57

Inherited From:

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

Inherited From:

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

Inherited From:

Node#root

Top-most ancestor from the current Node.

Example

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

sourceInnerHTML

Source:

Container.js, line 109

Return the stringified innerHTML from the source input.

sourceOuterHTML

Source:

Container.js, line 124

Return the stringified outerHTML from the source input.

textContent

Source:

Container.js, line 137

Return the text content of the current Container as a String.

textContent

Source:

Container.js, line 145

Define the content of the current Container as a new Text Node.

Methods

after(…nodes)

Source:

Node.js, line 105

Inherited From:

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

Inherited From:

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

Inherited From:

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

Inherited From:

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.

lastNth() → {Node|null}

Source:

Container.js, line 155

Return a child Node of the current Container by last index, or null if there is none.

Example

container.lastNth(0) // returns a Node or null

Returns:

Type: Node | null

lastNthElement() → {Element|null}

Source:

Container.js, line 165

Return a child Element of the current Container by last index, or null if there is none.

Example

container.lastNthElement(0) // returns an Element or null

Returns:

Type: Element | null

nth() → {Node|null}

Source:

Container.js, line 175

Return a child Node of the current Container by index, or null if there is none.

Example

container.nth(0) // returns a Node or null

Returns:

Type: Node | null

nthElement() → {Element|null}

Source:

Container.js, line 185

Return an Element child of the current Container by index, or null if there is none.

Example

container.nthElement(0) // returns an Element or null

Returns:

Type: Element | null

prepend(…nodes)

Source:

Node.js, line 167

Inherited From:

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

Inherited From:

Node#remove

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

Example

node.remove() // returns the current node

replaceAll(…nodes)

Source:

Container.js, line 195

Replace all of the children of the current Container, returning the current Container.

Example

container.replaceAll(new Text({ data: 'Hello World' }))

Parameters:

Name	Type	Attributes	Description
`nodes`	Array.<Node>	<repeatable>	Any nodes replacing the current children of the Container.

replaceWith(…nodes)

Source:

Node.js, line 196

Inherited From:

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.

visit(result, overrideVisitorsopt) → {ResultPromise}

Source:

Node.js, line 222

Inherited From:

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

walk(callback_or_filter, callback)

Source:

Container.js, line 234

Traverse the descendant Nodes of the current Container with a callback function, returning the current Container.

Examples

container.walk(node => {
  console.log(node);
})

container.walk('*', node => {
  console.log(node);
})

Walk only "section" Elements.

container.walk('section', node => {
  console.log(node); // logs only Section Elements
})

container.walk(/^section$/, node => {
  console.log(node); // logs only Section Elements
})

container.walk(
  node => node.name.toLowerCase() === 'section',
  node => {
  console.log(node); // logs only Section Elements
})

Walk only Text.

container.walk('#text', node => {
  console.log(node); // logs only Text Nodes
})

Parameters:

Name	Type	Description
`callback_or_filter`	function \| string \| RegExp	Callback function, or a filter to reduce Nodes the callback is applied to.
`callback`	function \| string \| RegExp	Callback function when a filter is also specified.

warn(result, text, optsopt)

Source:

Node.js, line 241

Inherited From:

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.