readme.md

nlcst-to-string

nlcst utility to serialize a node.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • toString(value)
• Types
• Compatibility
• Contribute
• License

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 16+), install with npm:

npm install nlcst-to-string

In Deno with esm.sh:

import {toString} from 'https://esm.sh/nlcst-to-string@4'

In browsers with esm.sh:

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

Use

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

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

API

This package exports the identifier toString. There is no default export.

toString(value)

Get the text content of a node or list of nodes.

Prefers the node’s plain-text fields, otherwise serializes its children, and if the given value is an array, serialize the nodes in it.

Parameters

• node (Array<Node> or Node) — node or list of nodes to serialize

Returns

Result (string).

Types

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

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, nlcst-to-string@^4, compatible with Node.js 16.

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