Node

Node

Create a new Node.

Constructor

new Node() → {Node}

Source:
Returns:
Type
Node

Extends

Members

index

Source:
Overrides:

The position of the current Node from its parent.

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

next

Source:
Overrides:

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

Example
node.next // returns null

nextElement

Source:
Overrides:

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

Example
node.nextElement // returns an element or null

previous

Source:
Overrides:

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

Example
node.previous // returns a node or null

previousElement

Source:
Overrides:

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

Example
node.previousElement // returns an element or null

root

Source:
Overrides:

The top-most ancestor from the current Node.

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

Methods

after(…nodes) → {Node}

Source:
Overrides:

Insert one ore more Nodes after 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.

Returns:
Type
Node

append(…nodes) → {Node}

Source:
Overrides:

Append Nodes or new Text Nodes to 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.

Returns:
Type
Node

appendTo(parent) → {Node}

Source:
Overrides:

Append the current Node to another Node.

Parameters:
Name Type Description
parent Container

The Container for the current Node.

Returns:
Type
Node

before(…nodes) → {Node}

Source:
Overrides:

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

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.

Returns:
Type
Node

prepend(…nodes) → {Node}

Source:
Overrides:

Prepend Nodes or new Text Nodes to 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.

Returns:
Type
Node

remove() → {Node}

Source:
Overrides:

Remove the current Node from its parent.

Example
node.remove() // returns the current node
Returns:
Type
Node

replaceWith(…nodes) → {Node}

Source:
Overrides:

Replace the current Node with another Node or Nodes.

Example
node.replaceWith(someOtherNode) // returns the current node
Parameters:
Name Type Attributes Description
nodes Node <repeatable>

Any nodes replacing the current Node.

Returns:
Type
Node

visit(result, overrideVisitorsopt) → {ResultPromise}

Source:
Overrides:

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

The 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:
Overrides:

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

The Result the warning is being added to.

text String

The message being sent as the warning.

opts Object <optional>

Additional information about the warning.