unified

Project: syntax-tree/mdast-util-phrasing

Package: mdast-util-phrasing@3.0.0

  1. Dependents: 0
  2. mdast utility to check if a node is phrasing content
  1. markdown 151
  2. util 147
  3. utility 143
  4. unist 133
  5. mdast 88
  6. phrasing 2

mdast-util-phrasing

Build Coverage Downloads Size Sponsors Backers Chat

mdast utility to check if a node is phrasing content.

Contents

What is this?

This package is a tiny utility to check that a given node is phrasing content.

When should I use this?

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.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install mdast-util-phrasing

In Deno with esm.sh:

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

In browsers with esm.sh:

<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 phrasing. There is no default export.

phrasing(node)

Check if the given value (unknown) is phrasing content.

Returns

Whether node 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 12.20+, 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) 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 © Victor Felder