mdast-util-definitions

mdast utility to get definitions by identifier.

Supports funky keys, like __proto__ or toString.

Install

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

identifier (string) — Identifier of definition.

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.

npm