Get unlimited public & private packages + team-based management with npm Teams.Learn more »

mdast-util-definitions

2.0.0 • Public • Published

mdast-util-definitions

Build Coverage Downloads Size Sponsors Backers Chat

mdast utility to get definitions by identifier.

Supports funky keys, like __proto__ or toString.

Install

npm:

npm install mdast-util-definitions

Usage

var remark = require('remark')
var definitions = require('mdast-util-definitions')
 
var ast = remark().parse('[example]: https://example.com "Example"')
 
var definition = definitions(ast)
 
definition('example')
// => {type: 'definition', 'title': 'Example', ...}
 
definition('foo')
// => null

API

definitions(node[, options])

Create a cache of all definitions in node.

options.commonmark

boolean, default: false — Turn on to use CommonMark precedence: ignore definitions found later for duplicate definitions. The default behaviour is to prefer the last found definition.

Returns

Function

definition(identifier)

Parameters
Returns

Node?Definition, if found.

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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer

Install

npm i mdast-util-definitions

DownloadsWeekly Downloads

448,998

Version

2.0.0

License

MIT

Unpacked Size

7.82 kB

Total Files

4

Last publish

Collaborators

  • avatar
  • avatar