Add type declarations for TypeScript users

[maxkreja]

It would be nice to have type declarations for TypeScript for this parser. Unfortunately the JSDoc type declarations aren't enough for TypeScript to work.

I will create the declarations based on your code and submit a pull request when it's done.

[matteodelabre]

Hi Max! Thank you for your interest in this parser. Unfortunately, I’m not that familiar with TypeScript, but I’d gladly accept your pull request if you find the time to add those declarations.

[carathorys]

Hi!

I've made a fork from this, and tried to convert it to TypeScript :)
You can check out my solution, I hope you'll like it. I've released it as saxophone-ts as it is a bit different than the original saxophone is, but it also have type declarations, so probably you can use it.

One additional thought:
After I made some changes, I was curios about how it performs, so I extended the original benchmarks, added the original Saxophone, and ran the test, the results are:

➜  saxophone-ts git:(master)> npm run benchmark

> saxophone-ts@0.0.0-development benchmark /Users/gallayb/src/saxophone-ts
> node benchmark --unhandled-rejections=none

SaxophoneTs x 13,804 ops/sec ±0.77% (88 runs sampled)
Saxophone x 7,731 ops/sec ±0.68% (89 runs sampled)
EasySax x 8,725 ops/sec ±0.52% (89 runs sampled)
node-expat x 862 ops/sec ±0.57% (88 runs sampled)
libxmljs.SaxParser x 772 ops/sec ±0.50% (88 runs sampled)
sax-js x 857 ops/sec ±0.41% (87 runs sampled)
Fastest is SaxophoneTs

[dobromyslov]

@carathorys have you seen these changes since your last commit?
https://github.com/carathorys/saxophone-ts/network

@matteodelabre has fixed and improved some parts of the original JS code.
@Miyou has also improved your TS version here: https://github.com/Miyou/saxophone-ts

Lets create types with https://github.com/microsoft/dts-gen

[dobromyslov]

@matteodelabre could you please merge these type definitions?
https://github.com/matteodelabre/saxophone/pull/12/files

[dobromyslov]

@maxkreja try to use saxes (https://github.com/lddubeau/saxes). It's a sax-js successor written in TypeScript. There is a stream wrapper available for it https://github.com/SmallhillCZ/saxes-stream and an async/await wrapper for serial events processing could also be created as proposed here lddubeau/saxes#32 (comment)

@matteodelabre could you please add benchmark comparison with saxes?

[kpachbiu88]

Just install additional package and use Sax with types
https://www.npmjs.com/package/@types/sax