8000 GitHub - syntax-tree/xast-util-to-string at 1.0.0
[go: up one dir, main page]

Skip to content

syntax-tree/xast-util-to-string

Repository files navigation

xast-util-to-string

Build Coverage Downloads Size Sponsors Backers Chat

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

This is like the DOMs Node#textContent getter but there are some deviations. The resulting text is returned.

Install

npm:

npm install xast-util-to-string

Use

var x = require('xastscript')
var toString = require('xast-util-to-string')

var 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

toString(node)

Utility to 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

string — Serialized node.

Security

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

Related

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

About

xast utility to get the text value of a node

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Contributors 2

  •  
  •  
0