[npm-image]: https://img.shields.io/npm/v/parse5-utilities.svg?style=flat-square
[npm-url]: https://npmjs.org/package/parse5-utilities
[downloads-image]: http://img.shields.io/npm/dm/parse5-utilities.svg?style=flat-square
[downloads-url]: https://npmjs.org/package/parse5-utilities
[ci-image]: https://github.com/cezaraugusto/parse5-utilities/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/cezaraugusto/parse5-utilities/actions/workflows/ci.yml

[![NPM version][npm-image]][npm-url]
[![Downloads][downloads-image]][downloads-url]
[![CI][ci-image]][ci-url]

parse5-utilities

Low-level parse5 node manipulation utilities.

API

$3

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

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

`$3`

> Parses HTML as a fragment.

`typescript createFragment(html: string): DocumentFragment`

`$3`

> Converts an AST node into an HTML string.

`typescript stringify(node: Node): string`

`$3`

> Get the attributes of a node as an object.

`typescript attributesOf(node: Node): Record`

`$3`

> Set an attribute on a node.

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

`$3`

> Get an attribute value from a node.

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

`$3`

> Remove an attribute from a node.

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

`$3`

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

`typescript toAttrs(attributes: Record): Attribute[]`

`$3`

> Create a new element node with the specified tag name.

`typescript createNode(tagName: string): Element`

`$3`

> Create a new text node with the specified text content.

`typescript createTextNode(text: string): TextNode`

`$3`

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

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

`$3`

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

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

`$3`

> Replace a node with another node.

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

`$3`

> Remove a node from its parent.

`typescript remove(node: ChildNode): ChildNode`

`$3`

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

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

`$3`

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

`typescript textOf(node: ParentNode): string`

`$3`

> Set the text content of a node.

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

`$3`

> Check if a string is likely a complete HTML document.

`typescript isDocument(string: string): boolean``

License

MIT License

[![NPM version][npm-image]][npm-url]
[![Downloads][downloads-image]][downloads-url]
[![CI][ci-image]][ci-url]

parse5-utilities

Low-level parse5 node manipulation utilities.

API

$3

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

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

`$3`

> Parses HTML as a fragment.

`typescript createFragment(html: string): DocumentFragment`

`$3`

> Converts an AST node into an HTML string.

`typescript stringify(node: Node): string`

`$3`

> Get the attributes of a node as an object.

`typescript attributesOf(node: Node): Record`

`$3`

> Set an attribute on a node.

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

`$3`

> Get an attribute value from a node.

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

`$3`

> Remove an attribute from a node.

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

`$3`

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

`typescript toAttrs(attributes: Record): Attribute[]`

`$3`

> Create a new element node with the specified tag name.

`typescript createNode(tagName: string): Element`

`$3`

> Create a new text node with the specified text content.

`typescript createTextNode(text: string): TextNode`

`$3`

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

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

`$3`

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

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

`$3`

> Replace a node with another node.

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

`$3`

> Remove a node from its parent.

`typescript remove(node: ChildNode): ChildNode`

`$3`

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

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

`$3`

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

`typescript textOf(node: ParentNode): string`

`$3`

> Set the text content of a node.

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

`$3`

> Check if a string is likely a complete HTML document.

`typescript isDocument(string: string): boolean``

License

MIT License