parse5-utilities

Low-level parse5 node manipulation utilities.

API

parse

Parse an HTML string. If smart is true, returns a document or documentFragment based on the input. Otherwise, always parses it as a document.

parse(html: string, smart?: boolean): Document | DocumentFragment

createFragment

Parses HTML as a fragment.

createFragment(html: string): DocumentFragment

stringify

Converts an AST node into an HTML string.

stringify(node: Node): string

attributesOf

Get the attributes of a node as an object.

attributesOf(node: Node): Record<string, string>

setAttribute

Set an attribute on a node.

setAttribute(node: Node, key: string, value: string): Node

getAttribute

Get an attribute value from a node.

getAttribute(node: Node, key: string): string | undefined

removeAttribute

Remove an attribute from a node.

removeAttribute(node: Node, key: string): void

toAttrs

Convert an object of attributes into an array of attribute objects.

toAttrs(attributes: Record<string, string>): Attribute[]

createNode

Create a new element node with the specified tag name.

createNode(tagName: string): Element

createTextNode

Create a new text node with the specified text content.

createTextNode(text: string): TextNode

prepend

Add a child to a node, making it the first child.

prepend(parent: ParentNode, node: ChildNode): ChildNode

append

Add a child to a node, making it the last child.

append(parent: ParentNode, node: ChildNode): ChildNode

replace

Replace a node with another node.

replace(originalNode: ChildNode, newNode: ChildNode): ChildNode | undefined

remove

Remove a node from its parent.

remove(node: ChildNode): ChildNode

flatten

Get all the nodes in a tree as a flat array.

flatten(node: Node | Node[]): Node[]

textOf

Get the text content of a node. Throws an error if the node has multiple children or non-text children.

textOf(node: ParentNode): string

setText

Set the text content of a node.

setText(node: ParentNode, text: string): ParentNode

isDocument

Check if a string is likely a complete HTML document.

isDocument(string: string): boolean

License

MIT License

Copyright (c) 2014 Jonathan Ong [email protected] Copyright (c) 2025 Cezar Augusto [email protected]