nlcst utility to transform a tree to a string
npm install nlcst-to-string[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
[nlcst][] utility to serialize a node.
* What is this?
* When should I use this?
* Install
* Use
* API
* toString(value)
* Types
* Compatibility
* Contribute
* License
This package is a utility that takes [nlcst][] nodes and gets their plain-text
value.
This is a small utility that is useful when you’re dealing with ASTs.
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
``sh`
npm install nlcst-to-string
In Deno with [esm.sh][esmsh]:
`js`
import {toString} from 'https://esm.sh/nlcst-to-string@4'
In browsers with [esm.sh][esmsh]:
`html`
`js
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'
`
This package exports the identifier [toString][api-to-string].
There is no default export.
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).
This package is fully typed with [TypeScript][].
It exports no additional types.
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.
See [contributing.md][contributing] in [syntax-tree/.github][health] forsupport.md`][support] for ways to get help.
ways to get started.
See [
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/syntax-tree/nlcst-to-string/workflows/main/badge.svg
[build]: https://github.com/syntax-tree/nlcst-to-string/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/nlcst-to-string.svg
[coverage]: https://codecov.io/github/syntax-tree/nlcst-to-string
[downloads-badge]: https://img.shields.io/npm/dm/nlcst-to-string.svg
[downloads]: https://www.npmjs.com/package/nlcst-to-string
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=nlcst-to-string
[size]: https://bundlejs.com/?q=nlcst-to-string
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[collective]: https://opencollective.com/unified
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/syntax-tree/unist/discussions
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[typescript]: https://www.typescriptlang.org
[license]: license
[author]: https://wooorm.com
[health]: https://github.com/syntax-tree/.github
[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
[support]: https://github.com/syntax-tree/.github/blob/main/support.md
[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
[nlcst]: https://github.com/syntax-tree/nlcst
[node]: https://github.com/syntax-tree/nlcst#nodes
[api-to-string]: #tostringvalue