Gathering detailed insights and metrics for hast-util-to-text
Gathering detailed insights and metrics for hast-util-to-text
Gathering detailed insights and metrics for hast-util-to-text
Gathering detailed insights and metrics for hast-util-to-text
hast-util-to-string
hast utility to get the plain-text value of a node
hast-util-from-string
hast utility to set the plain-text value of a node
hast-util-find-and-replace
hast utility to find and replace text in a tree
hast-util-minify-whitespace
hast utility to get the plain-text value of a node
utility to get the plain-text value of a node according to the `innerText` algorithm
npm install hast-util-to-text
Typescript
Module System
Node Version
NPM Version
JavaScript (100%)
Total Downloads
84,553,837
Last Day
96,662
Last Week
1,406,972
Last Month
5,872,381
Last Year
46,367,282
MIT License
21 Stars
78 Commits
2 Forks
8 Watchers
1 Branches
12 Contributors
Updated on Jun 03, 2025
Minified
Minified + Gzipped
Latest Version
4.0.2
Package Id
hast-util-to-text@4.0.2
Unpacked Size
33.28 kB
Size
10.28 kB
File Count
7
NPM Version
10.5.0
Node Version
21.7.1
Published on
Apr 16, 2024
Cumulative downloads
Total Downloads
Last Day
-1.6%
96,662
Compared to previous day
Last Week
-6.3%
1,406,972
Compared to previous week
Last Month
5.2%
5,872,381
Compared to previous month
Last Year
128.9%
46,367,282
Compared to previous year
hast utility to get the plain-text value of a node.
This package is a utility that takes a hast node and gets its plain-text
value.
It is like the DOMs Node#innerText
, which is a bit nicer than
Node#textContent
, because this turns <br>
elements into line breaks and
uses '\t'
(tabs) between table cells.
There are some small deviations from the spec, because the DOM has knowledge of
associated CSS, and can take into account that elements have display: none
or
text-transform
association with them, and this utility can’t do that.
This is a small utility that is useful when you want a plain-text version of a node that is close to how it’s “visible” to users.
This utility is similar to hast-util-to-string
, which
is simpler, and more like the Node#textContent
algorithm discussed above.
There is also a package hast-util-from-text
, which sort
of does the inverse: it takes a string, sets that as text on the node, while
turning line endings into <br>
s
This package is ESM only. In Node.js (version 16+), install with npm:
1npm install hast-util-to-text
In Deno with esm.sh
:
1import {toText} from 'https://esm.sh/hast-util-to-text@4'
In browsers with esm.sh
:
1<script type="module"> 2 import {toText} from 'https://esm.sh/hast-util-to-text@4?bundle' 3</script>
1import {h} from 'hastscript' 2import {toText} from 'hast-util-to-text' 3 4const tree = h('div', [ 5 h('h1', {hidden: true}, 'Alpha.'), 6 h('article', [ 7 h('p', ['Bravo', h('br'), 'charlie.']), 8 h('p', 'Delta echo \t foxtrot.') 9 ]) 10]) 11 12console.log(toText(tree))
Yields:
1Bravo 2charlie. 3 4Delta echo foxtrot.
This package exports the identifier toText
.
There is no default export.
toText(tree[, options])
Get the plain-text value of a node.
Serialized tree
(string
).
tree
is a comment, returns its value
tree
is a text, applies normal whitespace collapsing to its
value
, as defined by the CSS Text spectree
is a root or element, applies an algorithm similar to the
innerText
getter as defined by HTML👉 Note: the algorithm acts as if
tree
is being rendered, and as if we’re a CSS-supporting user agent, with scripting enabled.
tree
is an element that is not displayed (such as a head
), we’ll
still use the innerText
algorithm instead of switching to textContent
tree
are elements that are not displayed, they are
ignoredaudio
) are treated like non-replaced elementsOptions
Configuration (TypeScript type).
whitespace
(Whitespace
, default: 'normal'
)
— default whitespace setting to useWhitespace
Valid and useful whitespace values (from CSS) (TypeScript type).
1type Whitespace = 'normal' | 'nowrap' | 'pre' | 'pre-wrap'
This package is fully typed with TypeScript.
It exports the additional types Options
and
Whitespace
.
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-text@^4
,
compatible with Node.js 16.
hast-util-to-text
does not change the syntax tree so there are no
openings for cross-site scripting (XSS) attacks.
hast-util-to-string
— get the plain-text value (textContent
)hast-util-from-text
— set the plain-text value (innerText
)hast-util-from-string
— set the plain-text value (textContent
)See contributing.md
in syntax-tree/.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.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
Reason
security policy file detected
Details
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 2/30 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
Reason
branch protection not enabled on development/release branches
Details
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
Score
Last Scanned on 2025-06-30
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More