diff options
author | RaindropsSys <raindrops@equestria.dev> | 2023-11-17 23:25:29 +0100 |
---|---|---|
committer | RaindropsSys <raindrops@equestria.dev> | 2023-11-17 23:25:29 +0100 |
commit | 953ddd82e48dd206cef5ac94456549aed13b3ad5 (patch) | |
tree | 8f003106ee2e7f422e5a22d2ee04d0db302e66c0 /includes/external/addressbook/node_modules/dom-serializer/README.md | |
parent | 62a9199846b0c07c03218703b33e8385764f42d9 (diff) | |
download | pluralconnect-953ddd82e48dd206cef5ac94456549aed13b3ad5.tar.gz pluralconnect-953ddd82e48dd206cef5ac94456549aed13b3ad5.tar.bz2 pluralconnect-953ddd82e48dd206cef5ac94456549aed13b3ad5.zip |
Updated 30 files and deleted 2976 files (automated)
Diffstat (limited to 'includes/external/addressbook/node_modules/dom-serializer/README.md')
-rw-r--r-- | includes/external/addressbook/node_modules/dom-serializer/README.md | 109 |
1 files changed, 0 insertions, 109 deletions
diff --git a/includes/external/addressbook/node_modules/dom-serializer/README.md b/includes/external/addressbook/node_modules/dom-serializer/README.md deleted file mode 100644 index 0a301ab..0000000 --- a/includes/external/addressbook/node_modules/dom-serializer/README.md +++ /dev/null @@ -1,109 +0,0 @@ -# dom-serializer [![Build Status](https://travis-ci.com/cheeriojs/dom-serializer.svg?branch=master)](https://travis-ci.com/cheeriojs/dom-serializer) - -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 <code>emptyAttrs: false</code>: <code><input checked></code> - -**`example`** With <code>emptyAttrs: true</code>: <code><input checked=""></code> - ---- - -### `selfClosingTags` - -• `Optional` **selfClosingTags**: _boolean_ - -Print self-closing tags for tags without contents. - -**`default`** xmlMode - -**`example`** With <code>selfClosingTags: false</code>: <code><foo></foo></code> - -**`example`** With <code>selfClosingTags: true</code>: <code><foo /></code> - ---- - -### `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 |