unified

Project: syntax-tree/nlcst-to-string

Package: nlcst-to-string@3.1.0

  1. Dependents: 0
  2. nlcst utility to transform a tree to a string
  1. util 147
  2. utility 143
  3. unist 133
  4. stringify 19
  5. nlcst 15
  6. serialize 12
  7. nlcst-util 9
  8. string 7

nlcst-to-string

Build Coverage Downloads Size Sponsors Backers Chat

nlcst utility to serialize a node.

Contents

What is this?

This package is a utility that takes nlcst nodes and gets their plain-text value.

When should I use this?

This is a small utility that is useful when you’re dealing with ASTs.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install with npm:

npm install nlcst-util-to-string

In Deno with esm.sh:

import {toString} from "https://esm.sh/nlcst-util-to-string@3"

In browsers with esm.sh:

<script type="module">
  import {toString} from "https://esm.sh/nlcst-util-to-string@3?bundle"
</script>

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 identifier toString. There is no default export.

toString(node[, separator])

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

Parameters
Returns

string.

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

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