# dom-serializer
> render domhandler DOM nodes to a string
Latest version **3.1.1** (published 2026-05-02) · MIT license · 0 weekly downloads
## Install
```sh
npm install dom-serializer
pnpm add dom-serializer
yarn add dom-serializer
bun add dom-serializer
```
## Health
**Score 70/100 (B)** — status: active.
Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score; high quality score.
Warnings: low downloads.
## Facts
| | |
|---|---|
| Version | 3.1.1 |
| Published | 2026-05-02 |
| First published | 2014-05-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=20.19.0 |
| Dependencies | 3 |
| Unpacked size | 37.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 148 |
| Author | Felix Boehm |
| Maintainers | fb55 |
| Keywords | html, xml, render |
## Links
- npm: https://www.npmjs.com/package/dom-serializer
- Repository: https://github.com/cheeriojs/dom-serializer
- Homepage: https://github.com/cheeriojs/dom-serializer#readme
- Issues: https://github.com/cheeriojs/dom-serializer/issues
- Funding: https://github.com/cheeriojs/dom-serializer?sponsor=1
- npm.io page: https://npm.io/package/dom-serializer
## Dependencies (3)
- [entities](https://npm.io/package/entities.md) ^8.0.0
- [domhandler](https://npm.io/package/domhandler.md) ^6.0.0
- [domelementtype](https://npm.io/package/domelementtype.md) ^3.0.0
## Alternatives
- [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads
- [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads
- [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads
- [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads
- [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads
## Recent versions
- 3.1.1 (latest) — 2026-05-02
- 3.1.0 — 2026-05-02
- 3.0.0 — 2026-03-17
- 2.0.0 — 2022-04-09
- 1.4.1 — 2022-04-09
- 1.4.0 — 2022-04-09
- 1.3.2 — 2021-05-17
- 1.3.1 — 2021-04-08
- 1.3.0 — 2021-04-08
- 1.2.0 — 2020-12-05
- 1.1.0 — 2020-09-13
- 1.0.1 — 2020-05-09
- 1.0.0 — 2020-05-09
- 0.2.2 — 2019-11-09
- 0.2.1 — 2019-08-02
- … 5 more at https://npm.io/package/dom-serializer/versions
## README
# dom-serializer [](https://github.com/cheeriojs/dom-serializer/actions/workflows/nodejs-test.yml)
Renders a [domhandler](https://github.com/fb55/domhandler) DOM node or an array of domhandler DOM nodes to a string.
```js
import render from "dom-serializer";
// OR
const render = require("dom-serializer").default;
```
# API
## `render`
▸ **render**(`node`: Node \| Node[], `options?`: [_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_](#Options) | {} | 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](https://github.com/fb55/htmlparser2) | Fast & forgiving HTML/XML parser |
| [domhandler](https://github.com/fb55/domhandler) | Handler for htmlparser2 that turns documents into a DOM |
| [domutils](https://github.com/fb55/domutils) | Utilities for working with domhandler's DOM |
| [css-select](https://github.com/fb55/css-select) | CSS selector engine, compatible with domhandler's DOM |
| [cheerio](https://github.com/cheeriojs/cheerio) | The jQuery API for domhandler's DOM |
| [dom-serializer](https://github.com/cheeriojs/dom-serializer) | Serializer for domhandler's DOM |
---
LICENSE: MIT
---
_Source: https://npm.io/package/dom-serializer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._