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 145
  2. utility 141
  3. unist 132
  4. content 20
  5. text 19
  6. xml 10
  7. xast 8
  8. string 8
  9. xast-util 7


Build Coverage Downloads Size Sponsors Backers Chat

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


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).


This package is ESM only. In Node.js (version 16+), install with npm:

npm install xast-util-to-string

In Deno with esm.sh:

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

In browsers with esm.sh:

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


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

const tree = x(
  {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')])



A Christmas CarolCharles Dickens


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


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.


Serialized node (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, xast-util-to-string@^3, compatible with Node.js 16.


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


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.


MIT © Titus Wormer