Socket
Socket
Sign inDemoInstall

mdast-util-to-string

Package Overview
Dependencies
2
Maintainers
2
Versions
17
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

mdast-util-to-string

mdast utility to get the plain text content of a node


Version published
Maintainers
2
Weekly downloads
12,742,599
increased by4.5%

Weekly downloads

Package description

What is mdast-util-to-string?

The mdast-util-to-string package is a utility to extract plain text strings from an MDAST (Markdown Abstract Syntax Tree) node. It is commonly used when working with markdown processing or AST manipulation to get the string representation of a node without any markdown syntax.

What are mdast-util-to-string's main functionalities?

Extracting string from MDAST node

This feature allows you to pass an MDAST node to the `toString` function and receive a plain text string in return. It's useful for extracting readable text from markdown content.

const toString = require('mdast-util-to-string');
const mdast = {
  type: 'paragraph',
  children: [{type: 'text', value: 'Hello, world!'}]
};

const text = toString(mdast);
console.log(text); // 'Hello, world!'

Other packages similar to mdast-util-to-string

Readme

Source

mdast-util-to-string

Build Coverage Downloads Size Sponsors Backers Chat

mdast utility to get the text content of a node.

Contents

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
  • value (unknown) — thing to serialize, typically Node
  • options (Options, optional) — configuration
Returns

Serialized value (string).

Options

Configuration (TypeScript type).

Fields
  • 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.

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.

License

MIT © Titus Wormer

Keywords

FAQs

Last updated on 07 Jul 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc