dom-serializer

dom-serializer

Renders a domhandler DOM node or an array of domhandler DOM nodes to a string.

import render from "dom-serializer";

// OR

const render = require("dom-serializer").default;

API

render

▸ render(node: Node | Node[], options?: Options): string

Renders a DOM node or an array of DOM nodes to a string.

Can be thought of as the equivalent of the outerHTML of the passed node(s).

Parameters:

Name	Type	Default value	Description
node	Node | Node[]	-	Node to be rendered.
options	DomSerializerOptions	{}	Changes serialization behavior

Returns: string

Options

encodeEntities

• Optional encodeEntities: boolean | "utf8"

Encode characters reserved in HTML or XML in text and attribute values.

If xmlMode is true or the value is not 'utf8', characters outside of the ASCII range will be encoded as well.

Security: Setting this to false disables encoding of <, >, and & in text and attribute values. This is intended for the round-trip case where the DOM was parsed with decodeEntities: false, so markup characters only exist as entity references. If the DOM contains raw markup characters (e.g., from a default-decoded parse, or from programmatic manipulation), they will be emitted literally — do not use this option with untrusted input unless you have validated the DOM yourself.

default decodeEntities

decodeEntities

• Optional decodeEntities: boolean

Default for encodeEntities. Named to match the parser option of the same name so a single options object can be threaded through parse and serialize. Despite the name, on the serializer this option controls encoding — setting it to false carries the same security caveat as encodeEntities: false.

default true

emptyAttrs

• Optional emptyAttrs: boolean

Print an empty attribute's value.

default xmlMode

example With emptyAttrs: false: <input checked>

example With emptyAttrs: true: <input checked="">

selfClosingTags

• Optional selfClosingTags: boolean

Print self-closing tags for tags without contents. If xmlMode is set, this will apply to all tags. Otherwise, only tags that are defined as self-closing in the HTML specification will be printed as such.

default xmlMode

example With selfClosingTags: false: <foo></foo><br></br>

example With xmlMode: true and selfClosingTags: true: <foo/><br/>

example With xmlMode: false and selfClosingTags: true: <foo></foo><br />

xmlMode

• Optional xmlMode: boolean | "foreign"

Treat the input as an XML document; enables the emptyAttrs and selfClosingTags options.

If the value is "foreign", it will try to correct mixed-case attribute names.

default false

Ecosystem

Name	Description
htmlparser2	Fast & forgiving HTML/XML parser
domhandler	Handler for htmlparser2 that turns documents into a DOM
domutils	Utilities for working with domhandler's DOM
css-select	CSS selector engine, compatible with domhandler's DOM
cheerio	The jQuery API for domhandler's DOM
dom-serializer	Serializer for domhandler's DOM

LICENSE: MIT

Similar packages

Other packages similar to dom-serializer

parse5

parse5 is a fast full-featured HTML parsing and serialization library. It provides a variety of modules for parsing, serializing, and manipulating HTML documents. Compared to dom-serializer, parse5 offers a more comprehensive suite of HTML processing capabilities.

jsdom

jsdom is a pure-JavaScript implementation of many web standards, notably the WHATWG DOM and HTML Standards. It creates a virtual DOM and is capable of serializing and manipulating it. While dom-serializer focuses on serialization, jsdom offers a broader range of features including DOM emulation, scripting, and event simulation.

htmlparser2

htmlparser2 is a forgiving HTML and XML parser. It can also be used in conjunction with domhandler to create a DOM tree which can then be serialized. It is similar to dom-serializer in that it can be used to serialize DOM structures, but it also includes robust parsing capabilities.