mdast-util-phrasing

mdast utility to check if a node is phrasing content

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
mdast-util-phrasing
003.0.17 days ago5 years agoMinified + gzip package size for mdast-util-phrasing in KB

Readme

mdast-util-phrasing
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
mdast 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 uses unist-util-isunist-util-is, which you can use for your own checks.
A different utility, hast-util-phrasinghast-util-phrasing, does the same but on hast.

Install

This package is ESM onlyesm. In Node.js (version 14.14+ and 16.0+), install with npm:
npm install mdast-util-phrasing

In Deno with esm.shesmsh:
import {phrasing} from 'https://esm.sh/mdast-util-phrasing@3'

In browsers with esm.shesmsh:
<script type="module">
  import {phrasing} from 'https://esm.sh/mdast-util-phrasing@3?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 identifier phrasingapi-phrasing. There is no default export.

phrasing(value)

Check if the given value is phrasing contentphrasing.
Parameters
  • value (unknown)
— thing to check, typically [`Node`][node]
Returns
Whether value 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 all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Security

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)xss attacks.

Related

— check if a hast node is phrasing content
— check if a node passes a test

Contribute

See contributing.mdcontributing in syntax-tree/.githubhealth for ways to get started. See support.mdsupport 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.

License

MITlicense © Victor Felderauthor