-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
typings #197
typings #197
Conversation
Which is the state of that PR? |
any progress on this? |
+1 - this is needed. |
fyi I updated these typings and created a pull request in DefinitelyTyped project as maintainer of this project doesn't seem to be making this a priority. My pull request is at DefinitelyTyped/DefinitelyTyped#19031 |
Hi @hisham, If you'd like to send a pull request here as well I'll be happy to check it out. Hopefully, it can help a lot of our users. Thank you. |
Thanks @TalAter, now that the annyang type definitions is in DefinitelyTyped, we don't really need to add it to annyang package, although it is preferred from DefinitelyTyped perspective, but no real impact on anyone. Maybe I'll do it if I get some spare time here and there. |
I think it is better to to make merge request! Definitely Typed is kind of
deprecated if the project owner is willed to merge...
…On Do., 17. Aug. 2017, 22:58 Hisham A ***@***.***> wrote:
Thanks @TalAter <https://github.com/talater>, now that the annyang type
definitions is in DefinitelyTyped, we don't really need to add it to
annyang package, although it is preferred from DefinitelyTyped perspective,
but no real impact on anyone.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#197 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AAjdUl-mviZrbahU4mwMb-wXzGZiSsFeks5sZKmEgaJpZM4IS0bR>
.
|
@theluk maybe you're referring to https://github.com/typings/typings? That's deprecated but as far as I see https://github.com/DefinitelyTyped/DefinitelyTyped is very much active and supported. This is what they say in their documentation - I did the 2nd paragraph since this pull request didn't get merged and I needed the annyang type definitions.
|
Please make a pull request as the maintainer should have the chance to
merge it so that users do not have to make two separate dependencies.
…On Do., 17. Aug. 2017, 23:09 Hisham A ***@***.***> wrote:
@theluk <https://github.com/theluk> maybe you're referring to
https://github.com/typings/typings? That's deprecated but as far as I see
https://github.com/DefinitelyTyped/DefinitelyTyped is very much active
and supported.
This is what they say in their documentation - I did the 2nd paragraph
since this pull request didn't get merged and I needed the annyang type
definitions.
Create a new package
If you are the library author, or can make a pull request to the library,
bundle types instead of publishing to DefinitelyTyped.
If you are adding typings for an NPM package, create a directory with the
same name. If the package you are adding typings for is not on NPM, make
sure the name you choose for it does not conflict with the name of a
package on NPM. (You can use npm info foo to check for the existence of the
foo package.)
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#197 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AAjdUonnw8cvpzdV_lKea97sQ5c6eINhks5sZKwagaJpZM4IS0bR>
.
|
And only if it gets merged you may remove it from @types.
…On Do., 17. Aug. 2017, 23:16 Lukas Klinzing ***@***.***> wrote:
Please make a pull request as the maintainer should have the chance to
merge it so that users do not have to make two separate dependencies.
On Do., 17. Aug. 2017, 23:09 Hisham A ***@***.***> wrote:
> @theluk <https://github.com/theluk> maybe you're referring to
> https://github.com/typings/typings? That's deprecated but as far as I
> see https://github.com/DefinitelyTyped/DefinitelyTyped is very much
> active and supported.
>
> This is what they say in their documentation - I did the 2nd paragraph
> since this pull request didn't get merged and I needed the annyang type
> definitions.
>
> Create a new package
>
> If you are the library author, or can make a pull request to the library,
> bundle types instead of publishing to DefinitelyTyped.
>
> If you are adding typings for an NPM package, create a directory with the
> same name. If the package you are adding typings for is not on NPM, make
> sure the name you choose for it does not conflict with the name of a
> package on NPM. (You can use npm info foo to check for the existence of the
> foo package.)
>
> —
> You are receiving this because you were mentioned.
>
>
> Reply to this email directly, view it on GitHub
> <#197 (comment)>, or mute
> the thread
> <https://github.com/notifications/unsubscribe-auth/AAjdUonnw8cvpzdV_lKea97sQ5c6eINhks5sZKwagaJpZM4IS0bR>
> .
>
|
I agree, @theluk. I think it is best if we keep it within this package. This has several benefits:
|
Done - see #304. |
@theluk, @semagarcia, @jkuri |
typings in the .d.ts format to enhance type safety and autocompletion for TypeScript based apps
Description
I added a annyang.d.ts file reflecting the public api.
TODO
I copied most of the comments, and enhanced them. Altough copying is a ugly solution, i did not find a common practice how to do it better.
Motivation and Context
I wanted to use annyang in a angular2 project.
How Has This Been Tested?
there are no tests right now, as I have no experience in how to test type definition. Any help would be nice. @typings
Types of changes
Checklist: