Needless Patchouli Manufacture

    xast-util-from-xml
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    xast-util-from-xml

    Build Coverage Downloads Size Sponsors Backers Chat

    xast utility to parse from XML.

    Install

    This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

    npm:

    npm install xast-util-from-xml

    Use

    Say we have the following XML file, example.xml:

    <album id="123">
      <name>Born in the U.S.A.</name>
      <artist>Bruce Springsteen</artist>
      <releasedate>1984-04-06</releasedate>
    </album>

    And our script, example.js, looks as follows:

    import fs from 'fs'
    import {fromXml} from 'xast-util-from-xml'
    
    var doc = fs.readFileSync('example.xml')
    
    var tree = fromXml(doc)
    
    console.log(tree)

    Now, running node example yields (positional info removed for brevity):

    {
      type: 'root',
      children: [
        {
          type: 'element',
          name: 'album',
          attributes: {id: '123'},
          children: [
            {type: 'text', value: '\n  '},
            {
              type: 'element',
              name: 'name',
              attributes: {},
              children: [{type: 'text', value: 'Born in the U.S.A.'}]
            },
            {type: 'text', value: '\n  '},
            {
              type: 'element',
              name: 'artist',
              attributes: {},
              children: [{type: 'text', value: 'Bruce Springsteen'}]
            },
            {type: 'text', value: '\n  '},
            {
              type: 'element',
              name: 'releasedate',
              attributes: {},
              children: [{type: 'text', value: '1984-04-06'}]
            },
            {type: 'text', value: '\n'}
          ]
        },
        {type: 'text', value: '\n'}
      ]
    }

    API

    This package exports the following identifiers: fromXml. There is no default export.

    fromXml(doc)

    Parse XML to a xast tree.

    Parameters
    doc

    Value to parse (string or Buffer in UTF-8).

    Returns

    Root.

    Security

    XML can be a dangerous language: don’t trust user-provided data.

    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

    Install

    npm i xast-util-from-xml

    DownloadsWeekly Downloads

    70

    Version

    2.0.1

    License

    MIT

    Unpacked Size

    20.2 kB

    Total Files

    7

    Last publish

    Collaborators

    • wooorm
    • kmck