Product
Introducing Java Support in Socket
We're excited to announce that Socket now supports the Java programming language.
mdast-util-phrasing
Advanced tools
The `mdast-util-phrasing` package is a utility for working with MDAST (Markdown Abstract Syntax Tree) nodes that are considered 'phrasing content'. Phrasing content includes text and inline elements that can appear within a paragraph in Markdown. This package helps in identifying and manipulating such nodes.
Check if a node is phrasing content
This feature allows you to check if a given MDAST node is considered phrasing content. In the example, the node is a text node, which is phrasing content, so the function returns true.
const { phrasing } = require('mdast-util-phrasing');
const node = { type: 'text', value: 'Hello, world!' };
console.log(phrasing(node)); // true
Filter phrasing content from a list of nodes
This feature allows you to filter out only the phrasing content nodes from a list of MDAST nodes. In the example, only the text node is considered phrasing content, so it is the only node that remains after filtering.
const { phrasing } = require('mdast-util-phrasing');
const nodes = [
{ type: 'text', value: 'Hello, world!' },
{ type: 'paragraph', children: [] }
];
const phrasingNodes = nodes.filter(phrasing);
console.log(phrasingNodes); // [{ type: 'text', value: 'Hello, world!' }]
The `unist-util-visit` package is a utility for recursively visiting nodes in a Unist syntax tree, which includes MDAST. While it doesn't specifically focus on phrasing content, it can be used to traverse and manipulate nodes in a similar way.
The `mdast-util-to-string` package is used to get the plain text content of an MDAST node. It is useful for extracting text from nodes, but it doesn't specifically identify or filter phrasing content like `mdast-util-phrasing`.
The `unist-util-select` package allows you to select nodes in a Unist tree using CSS-like selectors. It can be used to find and manipulate specific types of nodes, including phrasing content, but it uses a different approach compared to `mdast-util-phrasing`.
mdast utility to check if a node is phrasing content.
This package is a tiny utility to check that a given node is phrasing content.
This utility is typically useful if you’re making other utilities.
It uses unist-util-is
, which you can use for your own checks.
A different utility, hast-util-phrasing
, does the same
but on hast.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install mdast-util-phrasing
In Deno with esm.sh
:
import {phrasing} from 'https://esm.sh/mdast-util-phrasing@4'
In browsers with esm.sh
:
<script type="module">
import {phrasing} from 'https://esm.sh/mdast-util-phrasing@4?bundle'
</script>
import {phrasing} from 'mdast-util-phrasing'
phrasing({type: 'paragraph', children: [{type: 'text', value: 'Alpha'}]})
// => false
phrasing({type: 'strong', children: [{type: 'text', value: 'Delta'}]})
// => true
This package exports the identifier phrasing
.
There is no default export.
phrasing(value)
Check if the given value is phrasing content.
👉 Note: Excludes
html
, which can be both phrasing or flow.
value
(unknown
)
— thing to check, typically Node
Whether value
is phrasing content (boolean
).
This package is fully typed with TypeScript. It does not export extra types.
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-phrasing@^4
,
compatible with Node.js 16.
Use of mdast-util-phrasing
does not involve hast, user content, or
change the tree, so there are no openings for cross-site scripting (XSS)
attacks.
hast-util-phrasing
— check if a hast node is phrasing contentunist-util-is
— check if a node passes a testSee 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.
FAQs
mdast utility to check if a node is phrasing content
The npm package mdast-util-phrasing receives a total of 4,283,226 weekly downloads. As such, mdast-util-phrasing popularity was classified as popular.
We found that mdast-util-phrasing demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
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.
Product
We're excited to announce that Socket now supports the Java programming language.
Security News
Socket detected a malicious Python package impersonating a popular browser cookie library to steal passwords, screenshots, webcam images, and Discord tokens.
Security News
Deno 2.0 is now available with enhanced package management, full Node.js and npm compatibility, improved performance, and support for major JavaScript frameworks.