typings v2

[hisham]

Bundling types as discussed in #197.

Description

• Added typescript definitions in types/index.d.ts
• Also added typescript definition test files along with necessary files to run the tests
• Followed instructions at https://github.com/Microsoft/dtslint to do this and using dtslint for testing
• Added 'types-test' command in package.json to run it, and added it to the grunt tasks

Motivation and Context

So that annyang can be easily used in typescript apps. See #197.

How Has This Been Tested?

• Added dtslint tests
• Tested using command line 'npm run types-test'
• And tested this latest package with my own typescript-based angular project - everything worked

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[TalAter]

Wow, this is a model pull request. You have thought of everything.

Give me some time to go over it, I am still new to the world of TypeScript.

[hisham]

thanks :) ᐧ

…

On Wed, Aug 23, 2017 at 2:34 PM, Tal Ater ***@***.***> wrote: Wow, this is a model pull request. You have thought of everything. Give me some time to go over it, I am still new to the world of TypeScript. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#304 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAE_vcySWS_Ioe0cQ1_mR0BpAcluXlnIks5sbIy6gaJpZM4PAS8C> .

[TalAter]

Does removeCommands() need to be repeated twice?

Could we do something like:
removeCommands(command?: string | string[]): void;

I am unsure of the syntax, so consider my suggestion pseudo code.

[TalAter]

Is export interface the correct way to do this?
Looking at this example, and at the footnote Preventing Name Conflicts, it looks like we might actually want to define a namespace annyang.

Am I understanding this wrong?

[hisham]

good points on both. now fixed.

[hisham]

So will this be merged? Would hate to have my pull request go to waste...

[TalAter]

Definitely! I am just not very experienced with TypeScript, and so asking for help with making sure I don't miss anything.

My apologies for it taking so long!

[anoblet]

This would be useful for me.