Updated types to fix multiple exports error and updated README

[paulblyth]

This should fix #16

[paulblyth]

@Aaronius is the TypeScript import of Penpal and the error codes the same as JavaScript? Didn't have time to check the vanilla JS import to see if it was the same, but you're exporting Penpal as default so I expect so?

[paulblyth]

Also build failing but I don't know why a change to the types and readme would break it.. 😇

[Aaronius]

Is your import example here specific to TypeScript users? Typically I would import like this:

import Penpal, { ERR_CONNECTION_DESTROYED } from 'penpal';

That kind of sucks if TypeScript users are forced to do it a different way.

[paulblyth]

That’ll probably work too actually. Brain must not have been in gear this morning. I can update in GitHub and update my PR but won’t be at my machine to test the TypeScript until tomorrow

[Aaronius]

No problem. The error constants are also statics on the Penpal object, so I don't really expect consumers to import both Penpal and the constants like you've shown here. They should be able to do:

import Penpal from 'penpal';
console.log(Penpal.ERR_CONNECTION_DESTROYED);

I only export the constants separately in case someone is only using the constants in a particular part of their code and doesn't want to include Penpal in that particular chunk (speaking in Webpack terms). I hope that makes sense. I tried to explain it in the readme:

This provides an opportunity for build optimization (using tools like Webpack or Rollup) in cases where code only needs access to the error constants and not the rest of Penpal.

Anyway, unless users of TypeScript need to do something unique, I'd probably leave this part out. I really should get a sample app with TypeScript working so I can test this stuff out.

[paulblyth]

I've checked and in typescript we can do import Penpal, { ERR_CONNECTION_DESTROYED } from 'penpal'; too so I've updated the README

[Aaronius]

Thanks for helping out @paulblyth. I don't think I understand your question in #17 (comment). It seems like the answer is probably yes. If you could clarify though I could tell you for sure.

Yeah, TravisCI and SauceLabs seem to be super finicky. Don't worry about it.

[Aaronius]

Thanks. I took a shot in the dark based on some docs I read, but apparently I missed the mark.

[paulblyth]

I’m still finding my feet. Lots of trial and error until it compiles...

The types is really nice though. If you ever fancy converting it fully to TypeScript I’d be happy to help out (the types come for free!)

[Aaronius]

Thanks for your help! Released in 3.0.1.