https://github.com/cheeriojs/dom-serializer
render dom nodes
https://github.com/cheeriojs/dom-serializer
cheeriojs htmlparser2
Last synced: 8 months ago
JSON representation
render dom nodes
- Host: GitHub
- URL: https://github.com/cheeriojs/dom-serializer
- Owner: cheeriojs
- License: mit
- Created: 2014-04-21T12:32:23.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-05-09T01:06:06.000Z (8 months ago)
- Last Synced: 2025-05-11T18:35:19.920Z (8 months ago)
- Topics: cheeriojs, htmlparser2
- Language: TypeScript
- Size: 3.11 MB
- Stars: 133
- Watchers: 4
- Forks: 69
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
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` **decodeEntities**: _boolean | "utf8"_
Encode characters that are either reserved in HTML or XML.
If `xmlMode` is `true` or the value not `'utf8'`, characters outside of the utf8 range will be encoded as well.
**`default`** `decodeEntities`
---
### `decodeEntities`
• `Optional` **decodeEntities**: _boolean_
Option inherited from parsing; will be used as the default value for `encodeEntities`.
**`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