unist-builder
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatunist utility to create trees with ease.
Contents
* [`u(type[, props][, children|value])`](#utype-props-childrenvalue)
* [`ChildrenOrValue`](#childrenorvalue)
* [`Props`](#props)
What is this?
This package is a hyperscript interface (likecreateElement
from React and
h
from Vue and such) to help with creating unist trees.When should I use this?
You can use this utility in your project when you generate syntax trees with code. It helps because it replaces most of the repetition otherwise needed in a syntax tree with function calls.You can instead use
hastscript
hastscript or xastscript
xastscript
when creating hast (HTML) or xast (XML) nodes.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install unist-builder
In Deno with
esm.sh
esmsh:import {u} from 'https://esm.sh/unist-builder@4'
In browsers with
esm.sh
esmsh:<script type="module">
import {u} from 'https://esm.sh/unist-builder@4?bundle'
</script>
Use
import {u} from 'unist-builder'
const tree = u('root', [
u('subtree', {id: 1}),
u('subtree', {id: 2}, [
u('node', [u('leaf', 'leaf 1'), u('leaf', 'leaf 2')]),
u('leaf', {id: 3}, 'leaf 3'),
u('void', {id: 4})
])
])
console.dir(tree, {depth: undefined})
…yields:
{
type: 'root',
children: [
{type: 'subtree', id: 1},
{
type: 'subtree',
id: 2,
children: [
{
type: 'node',
children: [
{type: 'leaf', value: 'leaf 1'},
{type: 'leaf', value: 'leaf 2'}
]
},
{type: 'leaf', id: 3, value: 'leaf 3'},
{type: 'void', id: 4}
]
}
]
}
API
This package exports the identifieru
u.
There is no default export.u(type[, props][, children|value])
Build a node.Signatures
u(type[, props], children)
— create a parent (Parent
parent)u(type[, props], value)
— create a literal (Literal
literal)u(type[, props])
— create a void node (neither parent not literal)
Parameters
type
(string
)
— node type
props
(Record<string, unknown>
)
— fields assigned to node
children
(Array<Node>
node)
— children of node
value
(*
)
— value of `node` (cast to string)
Returns
Built node (Node
node).ChildrenOrValue
List to use as children
or value to use as value
(TypeScript type).Type
type ChildrenOrValue = Array<Node> | string
Props
Other fields to add to the node (TypeScript type).Type
export type Props = Record<string, unknown>
Types
This package is fully typed with TypeScript. It exports the additional typesChildrenOrValue
childrenorvalue and
Props
props.Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line,
unist-builder@^4
,
compatible with Node.js 16.Related
— create [hast][] trees
— create [xast][] trees
Contribute
Seecontributing.md
contributing in syntax-tree/.github
health for
ways to get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.