Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

rexml

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

rexml

Simple XML parsing with a regular expression.

2.2.2
latest
Source
npm

Version published: 5 years ago

Weekly downloads: 98; decreased by-55.25%

Maintainers: 1

Weekly downloads

Created: 6 years ago

Source

rexml

rexml is a Node.JS package for simple XML parsing with a regular expression. It's been tested to work for simple use cases (does work on nested tags).

yarn add rexml

API

The package is available by importing its default and named functions:

import rexml, { extractProps, extractTagsSpec, extractPropSpec } from 'rexml'

`extractTags(`_{tag: string|!Array<string>,
string: string,}`): Return`

Extract member elements from an XML string. Numbers and booleans will be parsed into their JS types.

tag* (string | !Array<string>): Which tag to extract, e.g., div. Can also pass an array of tags, in which case the name of the tag will also be returned.
string* string: The XML string.

The tags are returned as an array with objects containing content and props properties. The content is the inner content of the tag, and props is the attributes specified inside the tag.

Source Output

Source	Output
import extractTags from 'rexml' const xml = ` <html> <div id="d1" class="example" contenteditable /> <div id="d2" class="example">Hello World</div> </html> ` const res = extractTags('div', xml)	`[ { content: '', props: { id: 'd1', class: 'example', contenteditable: true }, tag: 'div' }, { content: 'Hello World', props: { id: 'd2', class: 'example' }, tag: 'div' } ]`

import extractTags from 'rexml'

const xml = `
<html>
  <div id="d1"
    class="example"
    contenteditable />
  <div id="d2" class="example">Hello World</div>
</html>
`

const res = extractTags('div', xml)

[ { content: '',
    props: 
     { id: 'd1',
       class: 'example',
       contenteditable: true },
    tag: 'div' },
  { content: 'Hello World',
    props: { id: 'd2', class: 'example' },
    tag: 'div' } ]

Return: The return type.

Name	Type	Description
content*	string	The content of the tag, including possible whitespace.
props*	!Object<string, ?>	The properties of the element.
tag*	string	The name of the extracted element.

Extracting Multiple Tags

It's possible to give an array of tags which should be extracted from the XML string.

Source Output

Source	Output
import extractTags from 'rexml' const xml = `<html> <div id="d1"/> <div id="d2" class="example">Hello World</div> <footer>Art Deco, 2019</footer> </html> ` const res = extractTags(['div', 'footer'], xml)	`[ { content: '', props: { id: 'd1' }, tag: 'div' }, { content: 'Hello World', props: { id: 'd2', class: 'example' }, tag: 'div' }, { content: 'Art Deco, 2019', props: {}, tag: 'footer' } ]`

import extractTags from 'rexml'

const xml = `<html>
  <div id="d1"/>
  <div id="d2" class="example">Hello World</div>
  <footer>Art Deco, 2019</footer>
</html>
`

const res = extractTags(['div', 'footer'], xml)

[ { content: '',
    props: { id: 'd1' },
    tag: 'div' },
  { content: 'Hello World',
    props: { id: 'd2', class: 'example' },
    tag: 'div' },
  { content: 'Art Deco, 2019',
    props: {},
    tag: 'footer' } ]

`extractProps(`_{string: string,
parseValue?: boolean,}`): Object<string,(boolean|string|number)>`

Extracts the properties from the attributes part of the tag and returns them as an object. It will parse values if not specified otherwise.

Source Output

Source	Output
import { extractProps, extractPropsSpec } from 'rexml' const s = `id="d2" class="example" value="123" parsable="true" ignore="false" 2-non-spec required` const res = extractProps(s) console.log(JSON.stringify(res, null, 2)) // don't parse booleans and integers const res2 = extractProps(s, false) console.log(JSON.stringify(res2, null, 2)) // conform to the spec const res3 = extractPropsSpec(s) console.log(JSON.stringify(res3, null, 2))	`{ "id": "d2", "class": "example", "value": 123, "parsable": true, "ignore": false, "2-non-spec": true, "required": true } { "id": "d2", "class": "example", "value": "123", "parsable": "true", "ignore": "false", "2-non-spec": true, "required": true } { "id": "d2", "class": "example", "value": 123, "parsable": true, "ignore": false, "required": true }`

import { extractProps, extractPropsSpec } from 'rexml'

const s = `id="d2"
class="example"
value="123"
parsable="true"
ignore="false"
2-non-spec
required`

const res = extractProps(s)
console.log(JSON.stringify(res, null, 2))

// don't parse booleans and integers
const res2 = extractProps(s, false)
console.log(JSON.stringify(res2, null, 2))

// conform to the spec
const res3 = extractPropsSpec(s)
console.log(JSON.stringify(res3, null, 2))

{
  "id": "d2",
  "class": "example",
  "value": 123,
  "parsable": true,
  "ignore": false,
  "2-non-spec": true,
  "required": true
}
{
  "id": "d2",
  "class": "example",
  "value": "123",
  "parsable": "true",
  "ignore": "false",
  "2-non-spec": true,
  "required": true
}
{
  "id": "d2",
  "class": "example",
  "value": 123,
  "parsable": true,
  "ignore": false,
  "required": true
}

`extractTagsSpec(`_{tag: string,
string: string,}`): {content, props}[]`

Same as the default method, but confirms to the XML specification in defining attributes.

import { extractTagsSpec } from 'rexml'

const xml = `
<html>
  <div id="d1" class="example" contenteditable />
  <div 5-non-spec>Attributes cannot start with a number.</div>
</html>`

const res = extractTagsSpec('div', xml)

console.log(JSON.stringify(res, null, 2))

[
  {
    "props": {
      "id": "d1",
      "class": "example",
      "contenteditable": true
    },
    "content": ""
  }
]

Copyright

	© Art Deco 2019		Tech Nation Visa Sucks

2.2.2

[republish] Publish again due to yarn lag.

Keywords

FAQs

What is rexml?

Is rexml popular?

Is rexml well maintained?

Package last updated on 08 Aug 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

rexml

rexml

Table Of Contents

API

`extractTags(`_{tag: string|!Array<string>,
string: string,}`): Return`

Extracting Multiple Tags

`extractProps(`_{string: string,
parseValue?: boolean,}`): Object<string,(boolean|string|number)>`

`extractTagsSpec(`_{tag: string,
string: string,}`): {content, props}[]`

Copyright

2.2.2

Keywords

Related posts

rexml

rexml

Table Of Contents

API

extractTags( tag: string|!Array<string>, string: string,): Return

Extracting Multiple Tags

extractProps( string: string, parseValue?: boolean,): Object<string,(boolean|string|number)>

extractTagsSpec( tag: string, string: string,): {content, props}[]

Copyright

2.2.2

Keywords

Related posts

Weekly Downloads Now Available in npm Package Search Results

Tech's $90B Ghost Engineer Problem: Stanford Study Finds 9.5% of Engineers Do Almost Nothing

`extractTags(`_{tag: string|!Array<string>,
string: string,}`): Return`

`extractProps(`_{string: string,
parseValue?: boolean,}`): Object<string,(boolean|string|number)>`

`extractTagsSpec(`_{tag: string,
string: string,}`): {content, props}[]`