mdast-util-definitions

WebJar for mdast-util-definitions

License	MIT
GroupId	org.webjars.npm
ArtifactId	mdast-util-definitions
Last Version	3.0.1
Release Date	Aug 21, 2020
Type	jar
Description	mdast-util-definitions WebJar for mdast-util-definitions
Project URL	https://www.webjars.org
Source Code Management	https://github.com/syntax-tree/mdast-util-definitions

Download mdast-util-definitions

Filename	Size
mdast-util-definitions-3.0.1.pom
mdast-util-definitions-3.0.1.jar	7 KB
mdast-util-definitions-3.0.1-sources.jar	22 bytes
mdast-util-definitions-3.0.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/mdast-util-definitions/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>mdast-util-definitions</artifactId>
    <version>3.0.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/mdast-util-definitions/
implementation 'org.webjars.npm:mdast-util-definitions:3.0.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/mdast-util-definitions/
implementation ("org.webjars.npm:mdast-util-definitions:3.0.1")

Apache Buildr

'org.webjars.npm:mdast-util-definitions:jar:3.0.1'

Apache Ivy

<dependency org="org.webjars.npm" name="mdast-util-definitions" rev="3.0.1">
  <artifact name="mdast-util-definitions" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='mdast-util-definitions', version='3.0.1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "mdast-util-definitions" % "3.0.1"

Leiningen

[org.webjars.npm/mdast-util-definitions "3.0.1"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.webjars.npm : unist-util-visit	jar	[2.0.0,3)

Project Modules

There are no modules declared in this project.

mdast-util-definitions

mdast utility to get definitions by identifier.

Supports funky keys, like __proto__ or toString.

Install

npm:

npm install mdast-util-definitions

npm with TypeScript support:

npm install mdast-util-definitions @types/mdast

Use

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 definitions in tree.

Uses CommonMark precedence: prefers the first definitions for duplicate definitions.

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.

Related

• unist-util-index — index property values or computed keys to nodes

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

🌲🌲🌲🌳🌲🌳🌲🌲🌲🌳🌳🌲🌲🌳🌲🌲🎄🌲🌳🌲🌲🌳🐻🌳🌳🌳🌲🌲🌳🌲🎄🌲🌳🌲🌲🌳🌳🌳

Versions

Version
3.0.1 Aug 21, 2020
1.2.5 Jan 20, 2020
1.2.4 Aug 24, 2019