Alexandro.Net

Download README · GitHub release

@stackline/nlcst-to-string

nlcst utility to transform a tree to a string.

npm version license GitHub repository Docs Reddit community

Documentation | npm | Issues | Repository

Current package version: 1.0.2

Why this package?

@stackline/nlcst-to-string is the Stackline-maintained distribution of nlcst-to-string@3.1.1. It is an independent continuation of nlcst-to-string; original authors and licenses remain credited below.

Compatibility

Item Value
Package @stackline/nlcst-to-string@1.0.2
API target nlcst-to-string@3.1.1
Supported Node.js See supported framework requirements
License MIT
Module type module
Main entry index.js
Types index.d.ts
Runtime dependencies @types/nlcst

Installation

npm install @stackline/nlcst-to-string

Preserve existing imports and plugin resolution with an npm alias:

npm install nlcst-to-string@npm:@stackline/nlcst-to-string

Usage and API reference

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 @stackline/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 '@stackline/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
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.

License

MIT © Titus Wormer

Credits and original authors

Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.

Community and Links

Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.