mdast-util-to-string

mdast utility to get the plain text content of a node

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
mdast-util-to-string
2703.1.17 days ago8 years agoMinified + gzip package size for mdast-util-to-string in KB

Readme

mdast-util-to-string
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
mdast utility to get the text content of a node.

Contents

*   [`toString(value[, options])`](#tostringvalue-options)
*   [`Options`](#options)

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-markdownmdast-util-to-markdown does.
Similar packages, hast-util-to-stringhast-util-to-string and hast-util-to-texthast-util-to-text, do the same but on hast.

Install

This package is ESM onlyesm. In Node.js (version 14.14+ and 16.0+), install with npm:
npm install mdast-util-to-string

In Deno with esm.shesmsh:
import {toString} from 'https://esm.sh/mdast-util-to-string@3'

In browsers with esm.shesmsh:
<script type="module">
  import {toString} from 'https://esm.sh/mdast-util-to-string@3?bundle'
</script>

Use

import {unified} from 'unified'
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 toStringapi-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`][node]
— configuration
Returns
Serialized value (string).

Options

Configuration (TypeScript type).
Fields
  • includeImageAlt (boolean, default: true)
— whether to use `alt` for `image`s

Types

This package is fully typed with TypeScript. It exports the additional type Optionsapi-options.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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)xss attacks.

Related

— get text content in hast
— get text content in hast according to the `innerText` algorithm

Contribute

See contributing.mdcontributing in syntax-tree/.githubhealth for ways to get started. See support.mdsupport 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.

License

MITlicense © Titus Wormerauthor