Skip to content

Add Typescript Declarations#120

Open
naerbnic wants to merge 1 commit intoclarkie:masterfrom
naerbnic:add_typescript_declarations
Open

Add Typescript Declarations#120
naerbnic wants to merge 1 commit intoclarkie:masterfrom
naerbnic:add_typescript_declarations

Conversation

@naerbnic
Copy link
Copy Markdown

Added index.d.ts that contains the typings (as I have read them) from the rest of the library.

@naerbnic
Copy link
Copy Markdown
Author

If you see any problems with the typings given here, or if you have any idea of the right way to test this, I'm happy to hear it.

One thing I was thinking is rewriting one or more examples to use Typescript instead, and check that the usage of the library matches them.

@coveralls
Copy link
Copy Markdown

coveralls commented Nov 16, 2017

Coverage Status

Coverage remained the same at 98.66% when pulling 4f942b0 on naerbnic:add_typescript_declarations into 9678b7d on clarkie:master.

@jkav77
Copy link
Copy Markdown
Collaborator

jkav77 commented Jan 2, 2018

@naerbnic If you write some examples for the README.md then I think this is good to merge, right?

@cdhowie
Copy link
Copy Markdown
Collaborator

cdhowie commented Apr 9, 2018

I don't think tests are required. However, these definitions would need updating any time we make changes to our API. Do we have the manpower+discipline+expertise to keep these definitions up to date? @clarkie @dangerginger

@stephentuso
Copy link
Copy Markdown
Contributor

There is a declaration file and example usage available in DefinitelyTyped (@types/dynogels), but it is definitely preferable for types to be maintained here alongside the library. I've been using those without issue, I haven't looked at the differences in depth but there are at least a few things that could be added to this one, or might be best to just copy the other one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants