xml-twig 1.3.11 → 1.3.12

package/doc/twig.md

@@ -141,6 +141,7 @@ You can specify a <code>function</code> or a <code>event</code> name</p>
     * [.pinned](#Twig+pinned) ⇒ <code>boolean</code>
     * [.close](#Twig+close)
     * [.debug](#Twig+debug) ⇒ <code>string</code>
+    * [.toString](#Twig+toString) ⇒ <code>string</code>
     * [.addChild](#Twig+addChild) ℗
     * [.writer](#Twig+writer) ⇒ [<code>XMLWriter</code>](https://www.npmjs.com/package/xml-writer)
     * [.attr](#Twig+attr) ⇒ <code>string</code> \| <code>number</code> \| <code>object</code>
@@ -360,6 +361,13 @@ XML-Twig for dummies :-)
 
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Returns**: <code>string</code> - The XML-Tree which is currently available in RAM - no valid XML Structure  
+<a name="Twig+toString"></a>
+
+### twig.toString ⇒ <code>string</code>
+Returns XML string of the element
+
+**Kind**: instance property of [<code>Twig</code>](#Twig)  
+**Returns**: <code>string</code> - The XML-Element as string  
 <a name="Twig+addChild"></a>
 
 ### twig.addChild ℗
@@ -758,6 +766,7 @@ Common function to filter Twig element
     * [.pinned](#Twig+pinned) ⇒ <code>boolean</code>
     * [.close](#Twig+close)
     * [.debug](#Twig+debug) ⇒ <code>string</code>
+    * [.toString](#Twig+toString) ⇒ <code>string</code>
     * [.addChild](#Twig+addChild) ℗
     * [.writer](#Twig+writer) ⇒ [<code>XMLWriter</code>](https://www.npmjs.com/package/xml-writer)
     * [.attr](#Twig+attr) ⇒ <code>string</code> \| <code>number</code> \| <code>object</code>
@@ -977,6 +986,13 @@ XML-Twig for dummies :-)
 
 **Kind**: instance property of [<code>Twig</code>](#Twig)  
 **Returns**: <code>string</code> - The XML-Tree which is currently available in RAM - no valid XML Structure  
+<a name="Twig+toString"></a>
+
+### twig.toString ⇒ <code>string</code>
+Returns XML string of the element
+
+**Kind**: instance property of [<code>Twig</code>](#Twig)  
+**Returns**: <code>string</code> - The XML-Element as string  
 <a name="Twig+addChild"></a>
 
 ### twig.addChild ℗

package/package.json

@@ -5,7 +5,7 @@
   },
   "name": "xml-twig",
   "description": "Node module for processing huge XML documents in tree mode",
-  "version": "1.3.11",
+  "version": "1.3.12",
   "main": "twig.js",
   "directories": {
     "doc": "doc"

package/samples/memory-test.js

@@ -6,6 +6,7 @@ let Entry = 0;
 
 let parser = twig.createParser([{ tag: 'Entry', function: EntryHandler }], { method: 'expat' })
 // http://aiweb.cs.washington.edu/research/projects/xmltk/xmldata/data/SwissProt/SwissProt.xml.gz
+// For more files see http://aiweb.cs.washington.edu/research/projects/xmltk/xmldata/www/repository.html
 let reader = fs.createReadStream(`SwissProt.xml`);
 reader.pipe(parser);
 

package/twig.js

@@ -35,10 +35,13 @@ let current;
 * @see {@link https://www.npmjs.com/package/libxmljs|libxmljs}
 */
 
-/**
-* @external sax-wasm
-* @todo Not yet implemented, maybe later. Not sure if `WritableStream` is supported
-* @see {@link https://www.npmjs.com/package/sax-wasm|sax-wasm}
+/*
+* Other parsers I had a look at:
+* {@link https://www.npmjs.com/package/sax-wasm|sax-wasm}: not a 'stream.Writable'
+* {@link https://www.npmjs.com/package/@rubensworks/saxes|saxes}: not a 'stream.Writable'
+* {@link https://www.npmjs.com/package/node-xml-stream|node-xml-stream}: should work, but not implemented
+* {@link https://www.npmjs.com/package/saxes-stream|saxes-stream}: not a 'stream.Writable'
+* {@link https://www.npmjs.com/package/xml-streamer|xml-streamer}: based on 'node-expat', does not add any benefit
 */