unist-util-generated

unist utility to check if a node is generated.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

npm:

npm install unist-util-generated

Use

import {generated} from 'unist-util-generated'

generated({}) // => true

generated({position: {start: {}, end: {}}}) // => true

generated({
  position: {start: {line: 1, column: 1}, end: {line: 1, column: 2}}
}) // => false

API

This package exports the following identifiers: generated. There is no default export.

generated(node)

Check if node is generated.

Parameters

• node (Node) — Node to check.

Returns

boolean — Whether node is generated.

Related

• unist-util-position — Get the position of nodes
• unist-util-source — Get the source of a node or position
• unist-util-remove-position — Remove positions from a tree
• unist-util-stringify-position — Stringify a node, position, or point

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

Current Tags

• 2.0.0                                ...           latest (4 years ago)

3 Versions

• 2.0.0                                ...           4 years ago
• 1.1.6                                ...           5 years ago
• 1.1.5                                ...           6 years ago