Add an initial typescript definitions file for re-base version 2.8.0

[TheHandsomeCoder]

• A test file has been added to test the typings using the examples from the README.md.
• Added a call to the test script in package.json to compile the test script alongside the karma tests.
• Add a typings property to package.json

[qwales1]

@TheHandsomeCoder thanks! going to go through this today.

[TheHandsomeCoder]

@qwales1 just wanted to address your questions from the issue I submitted and to run something additional past you on it.

Right now I've provided a .tests.ts file which I run through the typescript compiler to ensure that the typings I've added are valid. However on reflection do you think it might be better to instead run the typings test on the karma tests themselves. That way we can ensure that when there are library updates if the tests are passing and compiling then tests using the typings is passing that the typings file is valid.

Also it's possible to add TSDoc to the typings files and get autogenerated documentation from webpack. would this be something you'd be interested in?

[qwales1]

@TheHandsomeCoder Would adding this work?
https://www.npmjs.com/package/typescript-definition-tester Ideally I was hoping for something like this that could re-run anytime the code changes like the other tests.

[TheHandsomeCoder]

I'll look into it tomorrow and see can I get it set up. I'll also look to just run the existing tests files through the typescript compiler as that is something that could also give the desired result

[coveralls]

Changes Unknown when pulling 82cb4e1 on TheHandsomeCoder:master into ** on tylermcginnis:2.x**.

[TheHandsomeCoder]

I seem to have updated against a different branch? What would be the best branch to redirect this PR to?

[qwales1]

@TheHandsomeCoder I think it should go to 2.x but looks like its maybe rebased on top of the master branch which is 3.x. Typing for 3.x should be a separate PR because the API has changed. It should be easy once its working on 2.x as its just deleting the auth, storage, messaging stuff and I think there is one small change to the syncState options.

[TheHandsomeCoder]

Cheers, will get it sorted

…

On 16 July 2017 at 23:01, Chris Wales ***@***.***> wrote: @TheHandsomeCoder <https://github.com/thehandsomecoder> I think it should go to 2.x but looks like its maybe rebased on top of the master branch which is 3.x. Typing for 3.x should be a separate PR because the API has changed. It should be easy once its working on 2.x as its just deleting the auth, storage, messaging stuff and I think there is one small change to the syncState options. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#207 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABfzRPOqHcZG9bL8ZOKjs2ph_uhVwfhPks5sOog1gaJpZM4NaiVj> .

-- - Scott

[TheHandsomeCoder]

I've reverted the merge from master and pulled from the 2.x branch instead. I've looked through the changes that were made since May 14th and there's nothing currently that I need to change in the typings.

I can however if you'd be interested add the current documentation from the readme to the typings as this can be used for code completion. example attached below.

Finally, I looked for a way to automatically test the typings file and I can't for the life of me find anything that does what you're looking for. It would seem that it just doesn't exist in typescript currently. If something is going in that is going to change the signature of the functions, then it needs to be manually updated in the typings.

[qwales1]

@TheHandsomeCoder awesome thanks. Sorry for the delay. Will go through this this weekend for sure.

[christianlacerda]

Hey @qwales1 , any chance to get this one merged soon?

Thank you!