nlcst-to-string

nlcst utility to transform a tree to a string

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
nlcst-to-string
1804.0.08 months ago10 years agoMinified + gzip package size for nlcst-to-string in KB

Readme

nlcst-to-string
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
nlcst utility to serialize a node.

Contents

*   [`toString(value)`](#tostringvalue)

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 onlyesm. In Node.js (version 16+), install with npm:
npm install nlcst-to-string

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

In browsers with esm.shesmsh:
<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 toStringapi-to-string. 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 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.mdcontributing in syntax-tree/.githubhealth for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor