hast-util-from-string

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

Contents

What is this?
When should I use this?
Install
Use
API
- fromString(node[, value])
Syntax
Syntax tree
Types
Compatibility
Security
Contribute
License

What is this?

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

When should I use this?

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

To use the DOMs Node#innerText algorithm instead, use hast-util-from-text. innerText is aware of how things are displayed, for example turning line endings into <br> elements and joining table cells with tab (\t) characters.

Install

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

npm install hast-util-from-string

In Deno with esm.sh:

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

In browsers with esm.sh:

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

Use

import {h} from 'hastscript'
import {fromString} from 'hast-util-from-string'

const p = h('p')
fromString(p, 'Alpha')
console.log(p)
// { type: 'element',
//   tagName: 'p',
//   properties: {},
//   children: [ { type: 'text', value: 'Alpha' } ] }

const div = h('div', [h('b', 'Bold'), ' and ', h('i', 'italic'), '.'])
fromString(div, 'Charlie')
console.log(div)
// { type: 'element',
//   tagName: 'div',
//   properties: {},
//   children: [ { type: 'text', value: 'Charlie' } ] }

API

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

`fromString(node[, value])`

Set the plain-text value of a node.

Parameters

node (Node) — node to change
value (string, default: '') — value to use

Returns

Nothing (undefined).

Algorithm

if node is a comment or text node, sets its value
if node is an element or root, replaces its children with a text node for value

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-from-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

Uh oh!