hast-util-to-string

hast-util-to-string

hast utility to get the plain-text value of a node.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • toString(node)
• Syntax
• Syntax tree
• Types
• Compatibility
• Security
• Contribute
• License

What is this?

This package is a utility to get the plain-text value of a node.

When should I use this?

You can use this package when you want to get the plain text value of a node. The algorithm used by this package is like the DOMs Node#textContent getter.

To use the DOMs Node#innerText algorithm instead, use hast-util-to-text. innerText is aware of how things are displayed, for example turning hard breaks (<br>) into line endings.

Install

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

npm install hast-util-to-string

In Deno with esm.sh:

import {toString} from 'https://esm.sh/hast-util-to-string@3'

In browsers with esm.sh:

<script type="module">
  import {toString} from 'https://esm.sh/hast-util-to-string@3?bundle'
</script>

Use

import {h} from 'hastscript'
import {toString} from 'hast-util-to-string'

toString(h('p', 'Alpha'))
//=> 'Alpha'
toString(h('div', [h('b', 'Bold'), ' and ', h('i', 'italic'), '.']))
//=> 'Bold and italic.'

API

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

toString(node)

Get the plain-text value of a node.

Parameters

• node (Node) — node to serialize

Returns

Serialized node (string).

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-to-string@^3, 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