Members
index
Position of the current Node from its parent.
Example
node.index // returns the index of the node or -1
next
Example
node.next // returns null
nextElement
Example
node.nextElement // returns an element or null
previous
Example
node.previous // returns a node or null
previousElement
Example
node.previousElement // returns an element or null
root
Top-most ancestor from the current Node.
Example
node.root // returns the top-most node or the current node itself
Methods
after(…nodes)
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)
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)
Parameters:
Name | Type | Description |
---|---|---|
parent |
Container |
before(…nodes)
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. |
prepend(…nodes)
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()
Example
node.remove() // returns the current node
replaceWith(…nodes)
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}
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)
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. |