4.2 KiB
nlcst-to-string
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 14.14+ and 16.0+), install with npm:
npm install nlcst-to-string
In Deno with esm.sh:
import {toString} from 'https://esm.sh/nlcst-to-string@3'
In browsers with esm.sh:
<script type="module">
import {toString} from 'https://esm.sh/nlcst-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(value[, separator])
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(NodeorArray<Node>) — node to serialize.separator(string, default:'') — value to delimit each item
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 all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.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.