unified

Project: syntax-tree/nlcst-to-string

Package: nlcst-to-string@3.1.0

  1. Dependents: 98
  2. nlcst utility to transform a tree to a string
  1. util 143
  2. utility 139
  3. unist 127
  4. stringify 18
  5. nlcst 14
  6. serialize 11
  7. nlcst-util 9
  8. string 7

nlcst-to-string

Build Coverage Downloads Size Sponsors Backers Chat

nlcst utility to serialize a node.

Install

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

npm:

npm install nlcst-to-string

Use

import {toString} from 'nlcst-to-string'

console.log(
  toString({
    type: 'WordNode',
    children: [
      {type: 'TextNode', value: 'AT'},
      {type: 'PunctuationNode', value: '&'},
      {type: 'TextNode', value: 'T'}
    ]
  })
) // => 'AT&T'

API

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

toString(node[, separator])

Stringify the given nlcst node (or list of nodes).

Parameters
Returns

string.

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