Logo for jsDocs.io

dom-serializer

  • Version 2.0.0
  • Published
  • 28.8 kB
  • 3 dependencies
  • MIT license

Install

npm i dom-serializer
yarn add dom-serializer
pnpm add dom-serializer

Overview

render domhandler DOM nodes to a string

Index

Functions

Interfaces

Functions

function render

render: (
    node: AnyNode | ArrayLike<AnyNode>,
    options?: DomSerializerOptions
) => 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).

    Parameter node

    Node to be rendered.

    Parameter options

    Changes serialization behavior

Interfaces

interface DomSerializerOptions

interface DomSerializerOptions {}

    property decodeEntities

    decodeEntities?: boolean;

    • Option inherited from parsing; will be used as the default value for encodeEntities.

      true

    property emptyAttrs

    emptyAttrs?: boolean;

    • Print an empty attribute's value.

      xmlMode

      Example 1

      With emptyAttrs: false: &lt;input checked&gt;

      Example 2

      With emptyAttrs: true: &lt;input checked=""&gt;

    property encodeEntities

    encodeEntities?: 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.

      decodeEntities

    property selfClosingTags

    selfClosingTags?: boolean;

    • Print self-closing tags for tags without contents.

      xmlMode

      Example 1

      With selfClosingTags: false: &lt;foo&gt;&lt;/foo&gt;

      Example 2

      With selfClosingTags: true: &lt;foo /&gt;

    property xmlMode

    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.

      false

    Package Files (1)

    Dependencies (3)

    Dev Dependencies (12)

    Peer Dependencies (0)

    No peer dependencies.

    Badge

    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/dom-serializer.

    • Markdown
      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/dom-serializer)
    • HTML
      <a href="https://www.jsdocs.io/package/dom-serializer"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>