unified

Project: syntax-tree/mdast-util-definitions

Package: mdast-util-definitions@5.1.1

  1. Dependents: 0
  2. mdast utility to find definition nodes in a tree
  1. util 147
  2. markdown 145
  3. utility 143
  4. unist 133
  5. mdast 90
  6. tree 44
  7. mdast-util 31
  8. node 25
  9. definition 15
  10. find 11

mdast-util-definitions

Build Coverage Downloads Size Sponsors Backers Chat

mdast utility to find definitions by identifier.

Contents

What is this?

This package is a tiny utility that lets you find definitions.

When should I use this?

This utility can be useful because definitions can occur after the things that reference them. It’s small and protects against prototype pollution.

Install

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

npm install mdast-util-definitions

In Deno with esm.sh:

import {definitions} from 'https://esm.sh/mdast-util-definitions@5'

In browsers with esm.sh:

<script type="module">
  import {definitions} from 'https://esm.sh/mdast-util-definitions@5?bundle'
</script>

Use

import {fromMarkdown} from 'mdast-util-from-markdown'
import {definitions} from 'mdast-util-definitions'

const tree = fromMarkdown('[example]: https://example.com "Example"')

const definition = definitions(tree)

definition('example')
// => {type: 'definition', 'title': 'Example', …}

definition('foo')
// => null

API

This package exports the identifier definitions. There is no default export.

definitions(node)

Find definitions in node (Node). Uses CommonMark precedence, which means that earlier definitions are preferred over duplicate later definitions.

Returns

definition (Function).

definition(identifier)

Get a node from the bound definition cache by its identifier (string).

Returns

Definition, if found (Node?)

Types

This package is fully typed with TypeScript. There are no additional exported 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-definitions does not involve hast or user content so there are no openings for cross-site scripting (XSS) attacks. Additionally, safe guards are in place to protect against prototype poisoning.

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 © Titus Wormer