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.

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

Add TypeScript typings and small documentation changes #544

Merged
merged 5 commits into from
Apr 13, 2020

Conversation

101arrowz
Copy link
Contributor

No functional changes were made; I only corrected some documentation and added TypeScript typings. This should allow TypeScript users to have compiler warnings when they input invalid data into functions, and should also allow JavaScript users with certain code editors (such as VSCode) to get better autocomplete.

@CLAassistant
Copy link

CLAassistant commented Mar 16, 2020

CLA assistant check
All committers have signed the CLA.

@JakeChampion JakeChampion self-requested a review March 16, 2020 23:07
@101arrowz
Copy link
Contributor Author

@JakeChampion Have you had time to review this yet?

@JakeChampion
Copy link
Owner

Hi @101arrowz, thanks for taking time to make this pull-request. This project does not use TypeScript and we ship JSDoc comments as our type documentation. I won't be accepting pull-request which as TypeScript types. Our other polyfill project has it's TypeScript types in the DefinitelyTyped @types project, I would recommend adding your types to the DefinitelyTyped project as well :-)

@101arrowz
Copy link
Contributor Author

101arrowz commented Mar 21, 2020

Alright, I'll submit the types to DefinitelyTyped. I'd like to ask that you consider updating at least the listAliases JSDoc, which suggests it returns an Array when it really returns an object. Thanks for the quick response!

@JakeChampion JakeChampion added library Relates to an Origami library maintenance Technical tasks that might make things better labels Mar 24, 2020
@JakeChampion JakeChampion requested a review from a team as a code owner April 13, 2020 23:33
@JakeChampion JakeChampion added the release:patch Add to a PR to trigger a PATCH version bump when merged label Apr 13, 2020
@JakeChampion JakeChampion merged commit 176f637 into JakeChampion:master Apr 13, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 14, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
library Relates to an Origami library maintenance Technical tasks that might make things better release:patch Add to a PR to trigger a PATCH version bump when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants