gnezim
150 lines
3.6 KiB
Markdown
150 lines
3.6 KiB
Markdown
# mdast-util-definitions
|
|
|
|
[![Build][build-badge]][build]
|
|
[![Coverage][coverage-badge]][coverage]
|
|
[![Downloads][downloads-badge]][downloads]
|
|
[![Size][size-badge]][size]
|
|
[![Sponsors][sponsors-badge]][collective]
|
|
[![Backers][backers-badge]][collective]
|
|
[![Chat][chat-badge]][chat]
|
|
|
|
[**mdast**][mdast] utility to get definitions by `identifier`.
|
|
|
|
Supports funky keys, like `__proto__` or `toString`.
|
|
|
|
## Install
|
|
|
|
[npm][]:
|
|
|
|
```sh
|
|
npm install mdast-util-definitions
|
|
```
|
|
|
|
[npm][] with [TypeScript][] support:
|
|
|
|
```sh
|
|
npm install mdast-util-definitions @types/mdast
|
|
```
|
|
|
|
## Use
|
|
|
|
```js
|
|
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(tree)`
|
|
|
|
Create a cache of all [definition][]s in [`tree`][node].
|
|
|
|
Uses CommonMark precedence: prefers the first definitions for duplicate
|
|
definitions.
|
|
|
|
###### Returns
|
|
|
|
[`Function`][fn-definition]
|
|
|
|
### `definition(identifier)`
|
|
|
|
###### Parameters
|
|
|
|
* `identifier` (`string`) — [Identifier][] of [definition][].
|
|
|
|
###### Returns
|
|
|
|
[`Node?`][node] — [Definition][], if found.
|
|
|
|
## Security
|
|
|
|
Use of `mdast-util-definitions` does not involve [**hast**][hast] or user
|
|
content so there are no openings for [cross-site scripting (XSS)][xss] attacks.
|
|
|
|
Additionally, safe guards are in place to protect against prototype poisoning.
|
|
|
|
## Related
|
|
|
|
* [`unist-util-index`](https://github.com/syntax-tree/unist-util-index)
|
|
— index property values or computed keys to nodes
|
|
|
|
## Contribute
|
|
|
|
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
|
|
started.
|
|
See [`support.md`][support] for ways to get help.
|
|
|
|
This project has a [code of conduct][coc].
|
|
By interacting with this repository, organization, or community you agree to
|
|
abide by its terms.
|
|
|
|
## License
|
|
|
|
[MIT][license] © [Titus Wormer][author]
|
|
|
|
<!-- Definitions -->
|
|
|
|
[build-badge]: https://img.shields.io/travis/syntax-tree/mdast-util-definitions.svg
|
|
|
|
[build]: https://travis-ci.org/syntax-tree/mdast-util-definitions
|
|
|
|
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-definitions.svg
|
|
|
|
[coverage]: https://codecov.io/github/syntax-tree/mdast-util-definitions
|
|
|
|
[downloads-badge]: https://img.shields.io/npm/dm/mdast-util-definitions.svg
|
|
|
|
[downloads]: https://www.npmjs.com/package/mdast-util-definitions
|
|
|
|
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-util-definitions.svg
|
|
|
|
[size]: https://bundlephobia.com/result?p=mdast-util-definitions
|
|
|
|
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
|
|
|
|
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
|
|
|
|
[collective]: https://opencollective.com/unified
|
|
|
|
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
|
|
|
|
[chat]: https://github.com/syntax-tree/unist/discussions
|
|
|
|
[license]: license
|
|
|
|
[author]: https://wooorm.com
|
|
|
|
[npm]: https://docs.npmjs.com/cli/install
|
|
|
|
[typescript]: https://www.typescriptlang.org/
|
|
|
|
[contributing]: https://github.com/syntax-tree/.github/blob/HEAD/contributing.md
|
|
|
|
[support]: https://github.com/syntax-tree/.github/blob/HEAD/support.md
|
|
|
|
[coc]: https://github.com/syntax-tree/.github/blob/HEAD/code-of-conduct.md
|
|
|
|
[mdast]: https://github.com/syntax-tree/mdast
|
|
|
|
[node]: https://github.com/syntax-tree/unist#node
|
|
|
|
[fn-definition]: #definitionidentifier
|
|
|
|
[definition]: https://github.com/syntax-tree/mdast#definition
|
|
|
|
[identifier]: https://github.com/syntax-tree/mdast#association
|
|
|
|
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
|
|
|
|
[hast]: https://github.com/syntax-tree/hast
|