@types/unist

Info associated with nodes by the ecosystem.

This space is guaranteed to never be specified by unist or specifications implementing unist. But you can use it in utilities and plugins to store data.

This type can be augmented to register custom data. For example:

declare module 'unist' {
  interface Data {
    // `someNode.data.myId` is typed as `number | undefined`
    myId?: number | undefined
  }
}

Abstract unist node that contains the smallest possible value.

This interface is supposed to be extended.

For example, in HTML, a text node is a leaf that contains text.

Abstract unist node.

The syntactic unit in unist syntax trees are called nodes.

This interface is supposed to be extended. If you can use Literal or Parent, you should. But for example in markdown, a thematicBreak (***), is neither literal nor parent, but still a node.

Abstract unist node that contains other nodes (*children*).

This interface is supposed to be extended.

For example, in XML, an element is a parent of different things, such as comments, text, and further elements.

One place in a source file.

Position of a node in a source document.

A position is a range between two points.