Gathering detailed insights and metrics for mdast-util-to-string
Gathering detailed insights and metrics for mdast-util-to-string
utility to get the plain text content of an mdast node
Installations
npm install mdast-util-to-stringDeveloper
Developer Guide
BETA
Module System
ESM
Min. Node Version
Typescript Support
Yes
Node Version
20.0.0
NPM Version
9.7.2
Statistics
39 Stars
133 Commits
9 Forks
10 Watching
1 Branches
12 Contributors
Updated on 08 Nov 2024
Bundle Size
693.00 B
Minified
387.00 B
Minified + Gzipped
Languages
JavaScript (100%)
Total Downloads
Cumulative downloads
Total Downloads
1,683,306,307
Last day
-1.7%
2,517,128
Compared to previous day
Last week
4%
13,252,124
Compared to previous week
Last month
13.5%
55,134,764
Compared to previous month
Last year
29.4%
624,183,875
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Versions
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:
1npm install mdast-util-to-string
In Deno with esm.sh:
1import {toString} from 'https://esm.sh/mdast-util-to-string@4'
In browsers with esm.sh:
1<script type="module"> 2 import {toString} from 'https://esm.sh/mdast-util-to-string@4?bundle' 3</script>
Use
1import {fromMarkdown} from 'mdast-util-from-markdown' 2import {toString} from 'mdast-util-to-string' 3 4const tree = fromMarkdown('Some _emphasis_, **importance**, and `code`.') 5 6console.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 usealtforimagesincludeHtml(boolean, default:true) — whether to usevalueof 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 theinnerTextalgorithm
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
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
0 existing vulnerabilities detected
Reason
license file detected
Details
- Info: project has a license file: license:0
- Info: FSF or OSI recognized license: MIT License: license:0
Reason
security policy file detected
Details
- Info: security policy file detected: github.com/syntax-tree/.github/security.md:1
- Info: Found linked content: github.com/syntax-tree/.github/security.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: github.com/syntax-tree/.github/security.md:1
- Info: Found text in security policy: github.com/syntax-tree/.github/security.md:1
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 1/30 approved changesets -- score normalized to 0
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/bb.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/syntax-tree/mdast-util-to-string/bb.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:10: update your workflow using https://app.stepsecurity.io/secureworkflow/syntax-tree/mdast-util-to-string/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/syntax-tree/mdast-util-to-string/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/syntax-tree/mdast-util-to-string/main.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/main.yml:15
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/bb.yml:1
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 1 are checked with a SAST tool
Score
4.1
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More