<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
value (unknown)
— thing to serialize, typically Node
includeImageAlt (boolean, default: true)
— whether to use alt for images
includeHtml (boolean, default: true)
— whether to use value 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.