Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/izatop/xml2o
Helps you convert XML into an object for easy reading.
https://github.com/izatop/xml2o
es6 nodejs sax sax-parser simplexml typescript xml xml-parser xml-to-js
Last synced: 3 months ago
JSON representation
Helps you convert XML into an object for easy reading.
- Host: GitHub
- URL: https://github.com/izatop/xml2o
- Owner: izatop
- License: mit
- Created: 2017-03-01T16:24:25.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-06-01T14:55:09.000Z (over 1 year ago)
- Last Synced: 2024-09-15T22:47:48.139Z (5 months ago)
- Topics: es6, nodejs, sax, sax-parser, simplexml, typescript, xml, xml-parser, xml-to-js
- Language: TypeScript
- Homepage:
- Size: 42.4 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# xml2o
Helps you convert XML into an object for easy reading.
## Getting Started
Install the package:
```bash
npm i -S xml2o
```
Let's convert XML from stream:
```typescript
import {convertStream} from 'xml2o';
import {createReadStream} from 'fs';
const node = convertStream(createReadStream('/path/to/file.xml'));
```
We can doing same with string:
```typescript
import {convertString} from 'xml2o';
const node = convertString('foo');
```
## Examples
A SimpleXML-like Node object made to help you read XML structures in JS without DOM.
**Check a node**
```typescript
import {convertString} from 'xml2o';
const xml = `
foo
`;
const node = convertString(xml);
console.log(node);
```
**Root of a node, name and inner text**
```typescript
console.log(
node.name,
node.text
);
```
**Child node name, text and attributes**
```typescript
console.log(
node[0].name,
node[0].text,
node[0].getAttribute('bar'),
node[0].getAttributeNode('bar'),
node[0].getAttributes()
)
```
**Node children**
```typescript
console.log(...node.map(child => child.name));
```
**Node query**
```typescript
import {convertString} from 'xml2o';
const node = convertString(xml);
console.log(node.query('/a')); // found /node/a
console.log(node.query('a')); // found /node/a, /node/b/a, /node/b/c/a, /node/d/c/a
console.log(node.query('c/a')); // found /node/b/c/a, /node/d/c/a
console.log(node.query('/d/c')); // found /node/d/c
console.log(node.query('b/a')); // found /node/b/a
```
## Documentation
| Method | Arguments | Return | Description |
|---|---|---|---|
| convertString | `XMLString` | `Node` | XML string
| convertStream | `stream` | `Node` | Readable stream
### Node
Node class used to present XML nodes as objects. Every Node object has following properties and methods:
**Properties**
| Property | Description |
|---|---|
| `name` | Tag name
| `local` | Tag local name
| `prefix` | Tag prefix
| `parent` | Parent Node
| `root` | Root Node
**Methods**
| Method | Arguments | Return | Description |
|---|---|---|---|
| `getAttribute` | `name, uri?` | `string` | Returns an attribute value
| `getAttributeNode`| `name, uri?` | `Attribute` | Returns an attribute
| `getAttributes` | | `Array` | Returns an array of attributes values
| `hasAttribute` | `name, uri?` | `boolean` | Returns true if an attribute is exists
| `query` | `name, uri?` | `Array` | Returns matched nodes in any level
# Note
Code examples written with modules so you may need babel, typescript or other to run its or rewrite ES6 imports to:
```js
const createString = require('xml2o').createString;
```
This library written in ES6 and if you need ES3 build you can tell me i'll make support for older JS versions.
# License
MIT