Skip to content
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.

Sign up for GitHub

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

Jump to bottom

TypeScript Definitions #12

Closed
philipp-spiess opened this issue Jul 22, 2018 · 8 comments
Closed

TypeScript Definitions #12

philipp-spiess opened this issue Jul 22, 2018 · 8 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@philipp-spiess
Copy link
Owner

We should consider adding TypeScript definitions before the 1.0.0 release.

However, I have not worked a lot with TypeScript so far. If anyone has experience with it, I would really appreciate your help.
@philipp-spiess philipp-spiess added enhancement New feature or request help wanted Extra attention is needed labels Jul 22, 2018
@philipp-spiess philipp-spiess added the good first issue Good for newcomers label Oct 4, 2018
@nataly87s
Copy link
Contributor

I would like to work on this issue

@philipp-spiess
Copy link
Owner Author

@nataly87s This is awesome! Thank you so much for your help - please feel free to reach out if you need any help and I will see what I can do 😊

@nataly87s
Copy link
Contributor

@philipp-spiess where do you want me to put the declaration file? under type-definitions folder?

@nataly87s nataly87s mentioned this issue Oct 11, 2018
Merged
philipp-spiess pushed a commit that referenced this issue Oct 11, 2018
@nataly87s @philipp-spiess
Add Typescript Definitions (#19)
7adcfa1 
following issue #12
@philipp-spiess
Copy link
Owner Author

Thank you for your help 🎉

There are two follow up tasks that we need to tackle:

  1. We need to make sure that the TypeScript declarations are part of the released npm package and are recognized by the TypeScript compiler.
  2. It would be great to add some tests as well.

If nobody knows better I'd take a look at the Immutable.js repository and see how they implemented this.

@nataly87s
Copy link
Contributor

I can do both tomorrow

@nataly87s
Copy link
Contributor

@philipp-spiess I'm working on the tests. anything specific you want to test, or are exported types enough?

@nataly87s nataly87s mentioned this issue Oct 12, 2018
Merged
philipp-spiess pushed a commit that referenced this issue Oct 13, 2018
@nataly87s @philipp-spiess
Bundle and test typescript declarations (#20)
f675153 
related to #12 
* updated build script to copy type declarations to dist dir
* added type tests
@philipp-spiess
Copy link
Owner Author

Woohoo thanks @nataly87s for working on this! This issue is resolved now 🎉

@philipp-spiess
Copy link
Owner Author

FYI released it as v1.0.0-rc.3 right now 🙂 Great job!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@philipp-spiess @nataly87s