hast-util-from-string
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorsfunding-sponsors-badgefunding
!Backersfunding-backers-badgefunding
!Chatchat-badgechathast
hast utility to set the plain-text value of a node.Contents
* [`fromString(node[, value])`](#fromstringnode-value)
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 DOMsNode#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 onlyesm. In Node.js (version 16+), install with npm:npm install hast-util-from-string
In Deno with
esm.sh
esm-sh:import {fromString} from 'https://esm.sh/hast-util-from-string@3'
In browsers with
esm.sh
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 identifierfromString
.
There is no default export.fromString(node[, value])
Set the plain-text value of a node.Parameters
node
(Node
) — node to changevalue
(string
, default:''
) — value to use
Returns
Nothing (undefined
).Algorithm
- if
node
is acomment
ortext
node, sets itsvalue
- if
node
is anelement
orroot
, 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)xss attack, use of rehype can also be unsafe. Userehype-sanitize
rehype-sanitize to make the tree safe.Contribute
Seecontributing.md
contributing in rehypejs/.github
health for ways
to get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.