annyang icon indicating copy to clipboard operation
annyang copied to clipboard

typings v2

Open hisham opened this issue 6 years ago • 6 comments

Bundling types as discussed in https://github.com/TalAter/annyang/pull/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 https://github.com/TalAter/annyang/pull/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)
  • [X] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

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

hisham avatar Aug 23 '17 16:08 hisham

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.

TalAter avatar Aug 23 '17 20:08 TalAter

thanks :) ᐧ

On Wed, Aug 23, 2017 at 2:34 PM, Tal Ater [email protected] 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 https://github.com/TalAter/annyang/pull/304#issuecomment-324454269, or mute the thread https://github.com/notifications/unsubscribe-auth/AAE_vcySWS_Ioe0cQ1_mR0BpAcluXlnIks5sbIy6gaJpZM4PAS8C .

hisham avatar Aug 23 '17 20:08 hisham

good points on both. now fixed.

hisham avatar Aug 24 '17 19:08 hisham

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

hisham avatar Sep 18 '17 17:09 hisham

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!

TalAter avatar Sep 22 '17 09:09 TalAter

This would be useful for me.

anoblet avatar Apr 04 '19 07:04 anoblet