{"_id":"@trysound/sax","_rev":"687764","name":"@trysound/sax","description":"An evented streaming XML parser in JavaScript","dist-tags":{"latest":"0.2.0"},"maintainers":[{"name":"trysound","email":"trysound@yandex.ru"}],"time":{"modified":"2021-08-30T23:00:52.000Z","created":"2021-02-23T09:23:03.785Z","0.2.0":"2021-08-30T22:50:39.924Z","0.1.1":"2021-02-23T16:59:25.326Z","0.1.0":"2021-02-23T09:23:03.785Z"},"users":{},"author":{"name":"Isaac Z. Schlueter","email":"i@izs.me","url":"http://blog.izs.me/"},"repository":{"type":"git","url":"git://github.com/svg/sax.git"},"versions":{"0.2.0":{"version":"0.2.0","name":"@trysound/sax","description":"An evented streaming XML parser in JavaScript","author":{"name":"Isaac Z. Schlueter","email":"i@izs.me","url":"http://blog.izs.me/"},"repository":{"type":"git","url":"git://github.com/svg/sax.git"},"license":"ISC","contributors":[{"name":"Bogdan Chadkin","email":"trysound@yandex.ru","url":"http://github.com/TrySound"}],"main":"lib/sax.js","engines":{"node":">=10.13.0"},"scripts":{"test":"tap test/*.js --cov -j4","lint":"standard -F test/*.js lib/*.js"},"devDependencies":{"standard":"^8.6.0","tap":"^10.5.1"},"gitHead":"ef549959f56d6dfd09fe243aa3b61b1096cb259a","bugs":{"url":"https://github.com/svg/sax/issues"},"homepage":"https://github.com/svg/sax#readme","_id":"@trysound/sax@0.2.0","_nodeVersion":"14.16.0","_npmVersion":"6.14.14","dist":{"shasum":"cccaab758af56761eb7bf37af6f03f326dd798ad","size":13541,"noattachment":false,"key":"/@trysound/sax/-/@trysound/sax-0.2.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/@trysound/sax/download/@trysound/sax-0.2.0.tgz"},"_npmUser":{"name":"trysound","email":"trysound@yandex.ru"},"directories":{},"maintainers":[{"name":"trysound","email":"trysound@yandex.ru"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sax_0.2.0_1630363839758_0.655985058793294"},"_hasShrinkwrap":false,"publish_time":1630363839924,"_cnpm_publish_time":1630363839924},"0.1.1":{"version":"0.1.1","name":"@trysound/sax","description":"An evented streaming XML parser in JavaScript","author":{"name":"Isaac Z. Schlueter","email":"i@izs.me","url":"http://blog.izs.me/"},"repository":{"type":"git","url":"git://github.com/svg/sax.git"},"license":"ISC","contributors":[{"name":"Bogdan Chadkin","email":"trysound@yandex.ru","url":"http://github.com/TrySound"}],"main":"lib/sax.js","engines":{"node":">=10.13.0"},"scripts":{"test":"tap test/*.js --cov -j4","lint":"standard -F test/*.js lib/*.js"},"devDependencies":{"standard":"^8.6.0","tap":"^10.5.1"},"gitHead":"60b84399d6a6e62a8af6d0dc351e9775ad5a4434","bugs":{"url":"https://github.com/svg/sax/issues"},"homepage":"https://github.com/svg/sax#readme","_id":"@trysound/sax@0.1.1","_nodeVersion":"14.10.1","_npmVersion":"6.14.8","dist":{"shasum":"3348564048e7a2d7398c935d466c0414ebb6a669","size":13512,"noattachment":false,"key":"/@trysound/sax/-/@trysound/sax-0.1.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/@trysound/sax/download/@trysound/sax-0.1.1.tgz"},"_npmUser":{"name":"trysound","email":"trysound@yandex.ru"},"directories":{},"maintainers":[{"name":"trysound","email":"trysound@yandex.ru"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sax_0.1.1_1614099565148_0.7967937559332416"},"_hasShrinkwrap":false,"publish_time":1614099565326,"_cnpm_publish_time":1614099565326},"0.1.0":{"version":"0.1.0","name":"@trysound/sax","description":"An evented streaming XML parser in JavaScript","author":{"name":"Isaac Z. Schlueter","email":"i@izs.me","url":"http://blog.izs.me/"},"repository":{"type":"git","url":"git://github.com/svg/sax.git"},"license":"ISC","contributors":[{"name":"Bogdan Chadkin","email":"trysound@yandex.ru","url":"http://github.com/TrySound"}],"main":"lib/sax.js","engines":{"node":">=10.13.0"},"scripts":{"test":"tap test/*.js --cov -j4","lint":"standard -F test/*.js lib/*.js"},"devDependencies":{"standard":"^8.6.0","tap":"^10.5.1"},"gitHead":"7311a50f04f52cdafdf2d593cbbbe78964afaa4b","bugs":{"url":"https://github.com/svg/sax/issues"},"homepage":"https://github.com/svg/sax#readme","_id":"@trysound/sax@0.1.0","_nodeVersion":"14.10.1","_npmVersion":"6.14.8","dist":{"shasum":"a06f11b605789c38510d71aa5370d76ba25cdfc6","size":13404,"noattachment":false,"key":"/@trysound/sax/-/@trysound/sax-0.1.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/@trysound/sax/download/@trysound/sax-0.1.0.tgz"},"_npmUser":{"name":"trysound","email":"trysound@yandex.ru"},"directories":{},"maintainers":[{"name":"trysound","email":"trysound@yandex.ru"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/sax_0.1.0_1614072183659_0.6507112423573544"},"_hasShrinkwrap":false,"publish_time":1614072183785,"_cnpm_publish_time":1614072183785}},"readme":"# svg/sax\n\nA maintained fork of [sax-js](https://github.com/isaacs/sax-js) sax-style parser for XML and HTML.\n\nDesigned with [node](http://nodejs.org/) in mind, but should work fine in\nthe browser or other CommonJS implementations.\n\n## What This Is\n\n* A very simple tool to parse through an XML string.\n* A stepping stone to a streaming HTML parser.\n* A handy way to deal with RSS and other mostly-ok-but-kinda-broken XML\n  docs.\n\n## What This Is (probably) Not\n\n* An HTML Parser - That's a fine goal, but this isn't it.  It's just\n  XML.\n* A DOM Builder - You can use it to build an object model out of XML,\n  but it doesn't do that out of the box.\n* XSLT - No DOM = no querying.\n* 100% Compliant with (some other SAX implementation) - Most SAX\n  implementations are in Java and do a lot more than this does.\n* An XML Validator - It does a little validation when in strict mode, but\n  not much.\n* A Schema-Aware XSD Thing - Schemas are an exercise in fetishistic\n  masochism.\n* A DTD-aware Thing - Fetching DTDs is a much bigger job.\n\n## Regarding `<!DOCTYPE`s and `<!ENTITY`s\n\nThe parser will handle the basic XML entities in text nodes and attribute\nvalues: `&amp; &lt; &gt; &apos; &quot;`. It's possible to define additional\nentities in XML by putting them in the DTD. This parser doesn't do anything\nwith that. If you want to listen to the `ondoctype` event, and then fetch\nthe doctypes, and read the entities and add them to `parser.ENTITIES`, then\nbe my guest.\n\nUnknown entities will fail in strict mode, and in loose mode, will pass\nthrough unmolested.\n\n## Usage\n\n```javascript\nvar sax = require(\"./lib/sax\"),\n  strict = true, // set to false for html-mode\n  parser = sax.parser(strict);\n\nparser.onerror = function (e) {\n  // an error happened.\n};\nparser.ontext = function (t) {\n  // got some text.  t is the string of text.\n};\nparser.onopentag = function (node) {\n  // opened a tag.  node has \"name\" and \"attributes\"\n};\nparser.onattribute = function (attr) {\n  // an attribute.  attr has \"name\" and \"value\"\n};\nparser.onend = function () {\n  // parser stream is done, and ready to have more stuff written to it.\n};\n\nparser.write('<xml>Hello, <who name=\"world\">world</who>!</xml>').close();\n```\n\n\n## Arguments\n\nPass the following arguments to the parser function.  All are optional.\n\n`strict` - Boolean. Whether or not to be a jerk. Default: `false`.\n\n`opt` - Object bag of settings regarding string formatting.  All default to `false`.\n\nSettings supported:\n\n* `trim` - Boolean. Whether or not to trim text and comment nodes.\n* `normalize` - Boolean. If true, then turn any whitespace into a single\n  space.\n* `lowercase` - Boolean. If true, then lowercase tag names and attribute names\n  in loose mode, rather than uppercasing them.\n* `xmlns` - Boolean. If true, then namespaces are supported.\n* `position` - Boolean. If false, then don't track line/col/position.\n* `strictEntities` - Boolean. If true, only parse [predefined XML\n  entities](http://www.w3.org/TR/REC-xml/#sec-predefined-ent)\n  (`&amp;`, `&apos;`, `&gt;`, `&lt;`, and `&quot;`)\n\n## Methods\n\n`write` - Write bytes onto the stream. You don't have to do this all at\nonce. You can keep writing as much as you want.\n\n`close` - Close the stream. Once closed, no more data may be written until\nit is done processing the buffer, which is signaled by the `end` event.\n\n`resume` - To gracefully handle errors, assign a listener to the `error`\nevent. Then, when the error is taken care of, you can call `resume` to\ncontinue parsing. Otherwise, the parser will not continue while in an error\nstate.\n\n## Members\n\nAt all times, the parser object will have the following members:\n\n`line`, `column`, `position` - Indications of the position in the XML\ndocument where the parser currently is looking.\n\n`startTagPosition` - Indicates the position where the current tag starts.\n\n`closed` - Boolean indicating whether or not the parser can be written to.\nIf it's `true`, then wait for the `ready` event to write again.\n\n`strict` - Boolean indicating whether or not the parser is a jerk.\n\n`opt` - Any options passed into the constructor.\n\n`tag` - The current tag being dealt with.\n\nAnd a bunch of other stuff that you probably shouldn't touch.\n\n## Events\n\nAll events emit with a single argument. To listen to an event, assign a\nfunction to `on<eventname>`. Functions get executed in the this-context of\nthe parser object. The list of supported events are also in the exported\n`EVENTS` array.\n\n`error` - Indication that something bad happened. The error will be hanging\nout on `parser.error`, and must be deleted before parsing can continue. By\nlistening to this event, you can keep an eye on that kind of stuff. Note:\nthis happens *much* more in strict mode. Argument: instance of `Error`.\n\n`text` - Text node. Argument: string of text.\n\n`doctype` - The `<!DOCTYPE` declaration. Argument: doctype string.\n\n`processinginstruction` - Stuff like `<?xml foo=\"blerg\" ?>`. Argument:\nobject with `name` and `body` members. Attributes are not parsed, as\nprocessing instructions have implementation dependent semantics.\n\n`sgmldeclaration` - Random SGML declarations. Stuff like `<!ENTITY p>`\nwould trigger this kind of event. This is a weird thing to support, so it\nmight go away at some point. SAX isn't intended to be used to parse SGML,\nafter all.\n\n`opentagstart` - Emitted immediately when the tag name is available,\nbut before any attributes are encountered.  Argument: object with a\n`name` field and an empty `attributes` set.  Note that this is the\nsame object that will later be emitted in the `opentag` event.\n\n`opentag` - An opening tag. Argument: object with `name` and `attributes`.\nIn non-strict mode, tag names are uppercased, unless the `lowercase`\noption is set.  If the `xmlns` option is set, then it will contain\nnamespace binding information on the `ns` member, and will have a\n`local`, `prefix`, and `uri` member.\n\n`closetag` - A closing tag. In loose mode, tags are auto-closed if their\nparent closes. In strict mode, well-formedness is enforced. Note that\nself-closing tags will have `closeTag` emitted immediately after `openTag`.\nArgument: tag name.\n\n`attribute` - An attribute node.  Argument: object with `name` and `value`.\nIn non-strict mode, attribute names are uppercased, unless the `lowercase`\noption is set.  If the `xmlns` option is set, it will also contains namespace\ninformation.\n\n`comment` - A comment node.  Argument: the string of the comment.\n\n`opencdata` - The opening tag of a `<![CDATA[` block.\n\n`cdata` - The text of a `<![CDATA[` block. Since `<![CDATA[` blocks can get\nquite large, this event may fire multiple times for a single block, if it\nis broken up into multiple `write()`s. Argument: the string of random\ncharacter data.\n\n`closecdata` - The closing tag (`]]>`) of a `<![CDATA[` block.\n\n`opennamespace` - If the `xmlns` option is set, then this event will\nsignal the start of a new namespace binding.\n\n`closenamespace` - If the `xmlns` option is set, then this event will\nsignal the end of a namespace binding.\n\n`end` - Indication that the closed stream has ended.\n\n`ready` - Indication that the stream has reset, and is ready to be written\nto.\n\n`noscript` - In non-strict mode, `<script>` tags trigger a `\"script\"`\nevent, and their contents are not checked for special xml characters.\nIf you pass `noscript: true`, then this behavior is suppressed.\n\n## Reporting Problems\n\nIt's best to write a failing test if you find an issue.  I will always\naccept pull requests with failing tests if they demonstrate intended\nbehavior, but it is very hard to figure out what issue you're describing\nwithout a test.  Writing a test is also the best way for you yourself\nto figure out if you really understand the issue you think you have with\nsax-js.\n","_attachments":{},"homepage":"https://github.com/svg/sax#readme","bugs":{"url":"https://github.com/svg/sax/issues"},"license":"ISC"}