xml-twig 1.1.0 → 1.1.2

package/README.md

@@ -51,7 +51,7 @@ With option `{ namespaces : true }` you will get access to the `.namespace` prop
 
 ### Read XML Document
 
-- Read entire XML file at once
+- **Read entire XML file at once**
 
   This module is designed to read huge XML-Files. Of course, it works also well for small files. First create the Twig parser. Then create a Stream and pipe it to the parser.
 
@@ -76,7 +76,7 @@ With option `{ namespaces : true }` you will get access to the `.namespace` prop
    // Output -> xml finished after 1 lines
    ```
 
-   If you prefer events, then use `event` property instead of `function` in handler declaration:
+   If you prefer [events](https://nodejs.org/api/events.html), then use `event` property instead of `function` in handler declaration:
 
    ```
    const parser = twig.createParser({ tag: twig.Root, event: 'rootElement' }, { method: 'sax' })
@@ -88,7 +88,7 @@ With option `{ namespaces : true }` you will get access to the `.namespace` prop
    ```
 
 
-- Read XML Document in chucks
+- **Read XML Document in chucks**
   
   The key feature of this module is to read and process XML files in chunks. You need to create handler functions for elements you like to process.
 
@@ -131,7 +131,7 @@ With option `{ namespaces : true }` you will get access to the `.namespace` prop
    web book at line 48
    ```
 
-- Read every element from XML Document
+- **Read every element from XML Document**
   
    ```
    function anyHandler(elt) {
@@ -140,7 +140,7 @@ With option `{ namespaces : true }` you will get access to the `.namespace` prop
    }
 
    const parser = twig.createParser({ tag: twig.Any, function: anyHandler }) 
-   // or with Regular Expression -> `{ tag: /i/, function: anyHandler }` 
+   // or with Regular Expression -> `{ tag: /./, function: anyHandler }` 
    // or with Function -> `{ tag: () => {return true}, function: anyHandler }`
    fs.createReadStream(`${__dirname}/bookstore.xml`).pipe(parser)
 
@@ -165,7 +165,7 @@ Be aware if you run methods like `elt.followingSibling()`, `elt.descendant()`, `
 `elt.root().children()[0].followingSibling()`
 
 
-- Read only parts from XML Document
+- **Read only parts from XML Document**
 
    If you like to read only certain elements, use option `partial: true`. The `root` element is always read. 
 
@@ -177,7 +177,7 @@ Be aware if you run methods like `elt.followingSibling()`, `elt.descendant()`, `
       { tag: twig.Root, function: rootHandler }
    ];
    const parser = twig.createParser(handle_ebook, { partial: true })
-   fs.createReadStream(`${__dirname}/samples/bookstore.xml`).pipe(parser);
+   fs.createReadStream(`${__dirname}/bookstore.xml`).pipe(parser);
 
    function ebookHandler(elt) {
       console.log(`${elt.name} at line ${parser.currentLine}`)

package/doc/build.sh

@@ -1,6 +1,6 @@
-#!/bin/bash
-
-jsdoc2md --private ../twig.js > ./twig.md
-
-# see https://github.com/jsdoc2md/jsdoc-to-markdown
-
+#!/bin/bash
+
+jsdoc2md --private ../twig.js > ./twig.md
+
+# see https://github.com/jsdoc2md/jsdoc-to-markdown
+

package/package.json

@@ -1,38 +1,38 @@
-{
-  "dependencies": {
-    "sax": "^1.3.0",
-    "xml-writer": "^1.7.0"
-  },
-  "name": "xml-twig",
-  "description": "Node module for processing huge XML documents in tree mode",
-  "version": "1.1.0",
-  "main": "twig.js",
-  "directories": {
-    "doc": "doc"
-  },
-  "devDependencies": {
-    "jsdoc-to-markdown": "^8.0.0",
-    "luxon": "^2.1.1",
-    "node-expat": "^2.4.0"
-  },
-  "scripts": {
-    "test": "node demo.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Wernfried/xml-twig.git"
-  },
-  "keywords": [
-    "xml",
-    "sax",
-    "expat",
-    "parser",
-    "xml-reader"
-  ],
-  "author": "Wernfried Domscheit",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/Wernfried/xml-twig/issues"
-  },
-  "homepage": "https://github.com/Wernfried/xml-twig#readme"
-}
+{
+  "dependencies": {
+    "sax": "^1.3.0",
+    "xml-writer": "^1.7.0"
+  },
+  "name": "xml-twig",
+  "description": "Node module for processing huge XML documents in tree mode",
+  "version": "1.1.2",
+  "main": "twig.js",
+  "directories": {
+    "doc": "doc"
+  },
+  "devDependencies": {
+    "jsdoc-to-markdown": "^8.0.0",
+    "luxon": "^2.1.1",
+    "node-expat": "^2.4.0"
+  },
+  "scripts": {
+    "test": "node demo.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Wernfried/xml-twig.git"
+  },
+  "keywords": [
+    "xml",
+    "sax",
+    "expat",
+    "parser",
+    "xml-reader"
+  ],
+  "author": "Wernfried Domscheit",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/Wernfried/xml-twig/issues"
+  },
+  "homepage": "https://github.com/Wernfried/xml-twig#readme"
+}

package/samples/memory-test.js

@@ -1,10 +1,11 @@
 const fs = require('fs');
 const process = require('process');
+const twig = require('xml-twig');
 
 let NE = 0;
 console.log('Starting...')
-let parser = require('xml-twig').createParser([{ name: 'subsession', function: anyHandler }], { method: 'expat' })
-let reader = fs.createReadStream(`${__dirname}/../samples/20231019015552.1-MSRAN.xml`);
+let parser = twig.createParser([{ tag: 'subsession', function: anyHandler }], { method: 'expat' })
+let reader = fs.createReadStream(`${__dirname}/20231019015552.1-MSRAN.xml`);
 reader.pipe(parser);
 
 function anyHandler(elt) {

package/samples/sample.js

@@ -1,7 +1,7 @@
 const fs = require('fs');
 const twig = require('../twig.js');
 
-/*
+
 // Sample 1.1
 function rootHandler(elt) {
    console.log(`<${elt.name}> finished after ${parser.currentLine} lines`);
@@ -67,7 +67,7 @@ parser = twig.createParser({ tag: twig.Any, function: anyHandler })
 // or with Regular Expression: `{ tag: tag: /i/, function: anyHandler }` 
 // or with Function: `{ tag: () => {return true}, function: anyHandler }`
 fs.createReadStream(`${__dirname}/bookstore.xml`).pipe(parser)
-*/
+
 
 // Sample 5
 const handle_ebook = [

package/samples/speed-test.js

@@ -1,11 +1,12 @@
 const { DateTime } = require('luxon');
-const startTime = DateTime.now();
 const fs = require('fs');
+const twig = require('xml-twig');
 
 let NE = 0;
+const startTime = DateTime.now();
 console.log('Starting...')
-let parser = require('xml-twig').createParser([{ name: 'subsession', function: anyHandler }], { method: 'expat' })
-let reader = fs.createReadStream(`${__dirname}/../samples/20231019015552.1-MSRAN.xml`);
+let parser = twig.createParser([{ tag: 'subsession', function: anyHandler }], { method: 'expat' })
+let reader = fs.createReadStream(`${__dirname}/20231019015552.1-MSRAN.xml`);
 reader.pipe(parser);
 
 function anyHandler(elt) {