unified

Project: syntax-tree/xast-util-to-string

Package: xast-util-to-string@2.0.0

  1. Dependents: 0
  2. xast utility to get the text value of a node
  1. util 147
  2. utility 143
  3. unist 131
  4. content 20
  5. text 19
  6. xml 10
  7. xast 8
  8. xast-util 7
  9. string 7

xast-util-to-string

Build Coverage Downloads Size Sponsors Backers Chat

xast utility to get the plain-text value of a node.

Contents

What is this?

This package is a utility that takes a xast node and gets its plain-text value. This is like the DOMs Node#textContent getter but there are some small deviations.

When should I use this?

This is a small utility that is useful when you want a plain-text version of a node when working with xast (XML).

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, 18.0+), install with npm:

npm install xast-util-to-string

In Deno with esm.sh:

import {toString} from "https://esm.sh/xast-util-to-string@2"

In browsers with esm.sh:

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

Use

import {x} from 'xastscript'
import {toString} from 'xast-util-to-string'

const tree = x(
  'ncx',
  {xmlns: 'http://www.daisy.org/z3986/2005/ncx/', version: '2005-1'},
  [
    x('head', [
      x('meta', {name: 'dtb:uid', content: 'urn:isbn:9781234567891'})
    ]),
    x('docTitle', [x('text', 'A Christmas Carol')]),
    x('docAuthor', [x('text', 'Charles Dickens')])
  ]
)

console.log(toString(tree))

Yields:

A Christmas CarolCharles Dickens

API

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

toString(node)

Get the plain text value of a node. If the node has a value field (cdata, comment, doctype, instruction, or text), returns it. If the node has a children field (root or element), recurses into it to concatenate all texts.

Returns

Serialized node (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 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Security

xast-util-to-string does not change the syntax tree so there are no openings for cross-site scripting (XSS) attacks.

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