Awesome
mdast-util-to-string
mdast utility to get the text content of a node.
Contents
- What is this?
- When should I use this?
- Install
- Use
- API
- Types
- Compatibility
- Security
- Related
- Contribute
- License
What is this?
This package is a tiny utility that gets the textual content of a node.
When should I use this?
This utility is useful when you have a node, say a heading, and want to get the text inside it.
This package does not serialize markdown, that’s what
mdast-util-to-markdown
does.
Similar packages, hast-util-to-string
and
hast-util-to-text
, do the same but on hast.
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install mdast-util-to-string
In Deno with esm.sh
:
import {toString} from 'https://esm.sh/mdast-util-to-string@4'
In browsers with esm.sh
:
<script type="module">
import {toString} from 'https://esm.sh/mdast-util-to-string@4?bundle'
</script>
Use
import {fromMarkdown} from 'mdast-util-from-markdown'
import {toString} from 'mdast-util-to-string'
const tree = fromMarkdown('Some _emphasis_, **importance**, and `code`.')
console.log(toString(tree)) // => 'Some emphasis, importance, and code.'
API
This package exports the identifier toString
.
There is no default export.
toString(value[, options])
Get the text content of a node or list of nodes.
Prefers the node’s plain-text fields, otherwise serializes its children, and if the given value is an array, serialize the nodes in it.
Parameters
Returns
Serialized value
(string
).
Options
Configuration (TypeScript type).
Fields
includeImageAlt
(boolean
, default:true
) — whether to usealt
forimage
sincludeHtml
(boolean
, default:true
) — whether to usevalue
of HTML
Types
This package is fully typed with TypeScript.
It exports the additional type Options
.
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, mdast-util-to-string@^4
,
compatible with Node.js 16.
Security
Use of mdast-util-to-string
does not involve hast, user content, or
change the tree, so there are no openings for cross-site scripting (XSS)
attacks.
Related
hast-util-to-string
— get text content in hasthast-util-to-text
— get text content in hast according to theinnerText
algorithm
Contribute
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.