Socket
Socket
Sign inDemoInstall

dom-serializer

Package Overview
Dependencies
3
Maintainers
3
Versions
17
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    dom-serializer

render domhandler DOM nodes to a string


Version published
Maintainers
3
Install size
829 kB
Created

Package description

What is dom-serializer?

The dom-serializer package is used to serialize DOM nodes to a string representation, typically HTML or XML. It is useful for transforming the DOM tree into a textual format that can be saved, transmitted, or manipulated as a string.

What are dom-serializer's main functionalities?

Serializing DOM nodes to HTML

This feature allows you to serialize a DOM node into an HTML string. The code sample demonstrates how to serialize a simple DOM element using dom-serializer.

const serialize = require('dom-serializer');
const dom = require('domhandler');
const root = new dom.Element('div', { class: 'container' });
const serialized = serialize(root);
console.log(serialized); // Outputs: <div class="container"></div>

Custom formatting options

dom-serializer allows for custom formatting options such as xmlMode, decodeEntities, and selfClosingTags. This code sample shows how to serialize a DOM element with XML formatting.

const serialize = require('dom-serializer');
const dom = require('domhandler');
const root = new dom.Element('div', { class: 'container' });
const options = { xmlMode: true };
const serialized = serialize(root, options);
console.log(serialized); // Outputs: <div class="container"/>

Other packages similar to dom-serializer

Readme

Source

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:
NameTypeDefault valueDescription
nodeNode | Node[]-Node to be rendered.
optionsDomSerializerOptions{}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.

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

NameDescription
htmlparser2Fast & forgiving HTML/XML parser
domhandlerHandler for htmlparser2 that turns documents into a DOM
domutilsUtilities for working with domhandler's DOM
css-selectCSS selector engine, compatible with domhandler's DOM
cheerioThe jQuery API for domhandler's DOM
dom-serializerSerializer for domhandler's DOM

LICENSE: MIT

Keywords

FAQs

Last updated on 09 Apr 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc