hast-util-minify-whitespace

hast-util-minify-whitespace

hast utility to minify whitespace between elements.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • Options
  • minifywhitespace(tree[, options])
• Syntax
• Syntax tree
• Types
• Compatibility
• Security
• Contribute
• License

What is this?

This package is a utility that can minify the whitespace between elements.

When should I use this?

You can use this package when you want to improve the size of HTML fragments.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install hast-util-minify-whitespace

In Deno with esm.sh:

import {minifyWhitespace} from 'https://esm.sh/hast-util-minify-whitespace@1'

In browsers with esm.sh:

<script type="module">
  import {minifyWhitespace} from 'https://esm.sh/hast-util-minify-whitespace@1?bundle'
</script>

Use

import {h} from 'hastscript'
import {minifyWhitespace} from 'hast-util-minify-whitespace'

const tree = h('p', [
  '  ',
  h('strong', 'foo'),
  '  ',
  h('em', 'bar'),
  '  ',
  h('meta', {itemProp: true}),
  '  '
])

minifyWhitespace(tree)

console.log(tree)
//=> h('p', [h('strong', 'foo'), ' ', h('em', 'bar'), h('meta', {itemProp: true})])

API

This package exports the identifier minifyWhitespace. There is no default export.

Options

Configuration (TypeScript type).

Fields

• newlines (boolean, default: false) — collapse whitespace containing newlines to '\n' instead of ' ' (default: false); the default is to collapse to a single space

Returns

Nothing (undefined).

minifywhitespace(tree[, options])

Minify whitespace.

Parameters

• tree (Node) — tree
• options (Options, optional) — configuration

Returns

Nothing (undefined).

Syntax

HTML is parsed according to WHATWG HTML (the living standard), which is also followed by all browsers.

Syntax tree

The syntax tree used is hast.

Types

This package is fully typed with TypeScript.

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, hast-util-minify-whitespace@^1, compatible with Node.js 16.

Security

As rehype works on HTML and improper use of HTML can open you up to a cross-site scripting (XSS) attack, use of rehype can also be unsafe. Use rehype-sanitize to make the tree safe.

Contribute

See contributing.md in rehypejs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer