pHTML

Constructor

new Result(html, processOptionsopt)

Source:

Result.js, line 17

Parameters:

Name	Type	Attributes	Description
`html`	string		HTML string to be parsed.
`processOptions`	ProcessOptions	<optional>	Custom settings applied to the Result.

Members

from :string

Source:

Result.js, line 25

Path to the HTML source file. You should always set from, because it is used in source map generation and syntax error messages

Type:

string

html

Source:

Result.js, line 62

Current Root as a String.

messages :Array.<Message>

Source:

Result.js, line 48

List of the messages gathered during transformations

Type:

Array.<Message>

root :Node

Source:

Result.js, line 58

Root Node

Type:

Node

to :string

Source:

Result.js, line 31

Path to the HTML output file

Type:

string

type :'result'

Source:

Result.js, line 20

Type identifier of the Result

Type:

'result'

visitors :Object.<string, Array.<function()>>

Source:

Result.js, line 44

Normalized plugins and visitors

Type:

Object.<string, Array.<function()>>

voidElements :Array.<string>

Source:

Result.js, line 37

List of the elements that only have a start tag, as they cannot have any content

Type:

Array.<string>

warnings

Source:

Result.js, line 70

Messages that are warnings.

Methods

normalize(nodeopt)

Source:

Result.js, line 82

Return a normalized node whose instances match the current Result.

Example

result.normalize(someNode)

Parameters:

Name	Type	Attributes	Description
`node`	Node	<optional>	Node to be normalized.

toJSON() → {Object}

Source:

Result.js, line 90

Current Root as an Object.

Returns:

Type: Object

visit(node, overrideVisitorsopt) → {ResultPromise}

Source:

Result.js, line 110

Transform the current Node and any descendants using visitors.

Examples

await result.visit(someNode)

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

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

Parameters:

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

Returns:

Type: ResultPromise

warn(text, optsopt)

Source:

Result.js, line 128

Add a warning to the current Root.

Examples

result.warn('Something went wrong')

result.warn('Something went wrong', {
  node: someNode,
  plugin: somePlugin
})

Parameters:

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