dom-serializer (1.4.1)

Published 2026-02-24 13:55:37 +00:00 by atheaadmin

Installation

registry=
npm install dom-serializer@1.4.1
"dom-serializer": "1.4.1"

About this package

dom-serializer Build Status

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

decodeEntities

Optional decodeEntities: boolean

Encode characters that are either reserved in HTML or XML, or are outside of the ASCII range.

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.

default xmlMode

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

example With selfClosingTags: true: <foo />


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

Dependencies

Dependencies

ID Version
domelementtype ^2.0.1
domhandler ^4.2.0
entities ^2.0.0

Development Dependencies

ID Version
@types/jest ^26.0.23
@types/node ^15.3.0
@typescript-eslint/eslint-plugin ^4.23.0
@typescript-eslint/parser ^4.23.0
cheerio ^1.0.0-rc.9
coveralls ^3.0.5
eslint ^7.26.0
eslint-config-prettier ^8.3.0
htmlparser2 ^6.1.0
jest ^26.0.1
prettier ^2.3.0
ts-jest ^26.5.6
typescript ^4.0.2

Keywords

html xml render
Details
npm
2026-02-24 13:55:37 +00:00
0
Felix Boehm
MIT
latest
7.3 KiB
Assets (1)
Versions (2) View all
0.2.2 2026-02-24
1.4.1 2026-02-24