Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://github.com/syntax-tree/mdast-util-to-string below:

syntax-tree/mdast-util-to-string: utility to get the plain text content of an mdast node

mdast utility to get the text content of a node.

• What is this?
• When should I use this?
• Install
• Use
• API
  • toString(value[, options])
  • Options
• Types
• Compatibility
• Security
• Related
• Contribute
• License

This package is a tiny utility that gets the textual content of a node.

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.

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>

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.'

This package exports the identifier toString. There is no default export.

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.

• value (unknown) — thing to serialize, typically Node
• options (Options, optional) — configuration

Serialized value (string).

Configuration (TypeScript type).

• includeImageAlt (boolean, default: true) — whether to use alt for images
• includeHtml (boolean, default: true) — whether to use value of HTML

This package is fully typed with TypeScript. It exports the additional type Options.

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.

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.

• hast-util-to-string — get text content in hast
• hast-util-to-text — get text content in hast according to the innerText algorithm

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.

MIT © Titus Wormer

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4