mdast-util-phrasing
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatmdast utility to check if a node is phrasing content.
Contents
* [`phrasing(value)`](#phrasingvalue)
What is this?
This package is a tiny utility to check that a given node is phrasing contentphrasing.When should I use this?
This utility is typically useful if you’re making other utilities. It usesunist-util-is
unist-util-is, which you can use for your own checks.A different utility,
hast-util-phrasing
hast-util-phrasing, does the same
but on hast.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install mdast-util-phrasing
In Deno with
esm.sh
esmsh:import {phrasing} from 'https://esm.sh/mdast-util-phrasing@4'
In browsers with
esm.sh
esmsh:<script type="module">
import {phrasing} from 'https://esm.sh/mdast-util-phrasing@4?bundle'
</script>
Use
import {phrasing} from 'mdast-util-phrasing'
phrasing({type: 'paragraph', children: [{type: 'text', value: 'Alpha'}]})
// => false
phrasing({type: 'strong', children: [{type: 'text', value: 'Delta'}]})
// => true
API
This package exports the identifierphrasing
api-phrasing.
There is no default export.phrasing(value)
Check if the given value is phrasing contentphrasing.👉 Note: Excludes html
, which can be both phrasing or flow.
Parameters
value
(unknown
)
— thing to check, typically [`Node`][node]
Returns
Whethervalue
is phrasing content (boolean
).Types
This package is fully typed with TypeScript. It does not export extra types.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-phrasing@^4
,
compatible with Node.js 16.Security
Use ofmdast-util-phrasing
does not involve hast, user content, or
change the tree, so there are no openings for cross-site scripting (XSS)xss
attacks.Related
— check if a hast node is phrasing content
— check if a node passes a test
Contribute
Seecontributing.md
contributing in syntax-tree/.github
health for
ways to get started.
See support.md
support 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.