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 type definitions #357

Merged
merged 2 commits into from
Jan 4, 2022
Merged

Add TypeScript type definitions #357

merged 2 commits into from
Jan 4, 2022

Conversation

dellisd
Copy link
Contributor

@dellisd dellisd commented Dec 28, 2021

This addresses #290 and adds type definitions for all components.

Ideally these types would live in this repository so that they can be updated as the library itself is updated, but I can move this to DefinitelyTyped if preferred.

@codecov
Copy link

codecov bot commented Jan 4, 2022

Codecov Report

Merging #357 (aed483c) into main (f2a667b) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #357   +/-   ##
=======================================
  Coverage   98.33%   98.33%           
=======================================
  Files          26       26           
  Lines         721      721           
  Branches      180      180           
=======================================
  Hits          709      709           
  Misses          8        8           
  Partials        4        4           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f2a667b...aed483c. Read the comment docs.

@stepankuzmin
Copy link
Member

Hey @dellisd,

That's great! Thanks for the contribution

@stepankuzmin stepankuzmin merged commit fd7b869 into urbica:main Jan 4, 2022
@josh-cloudscape
Copy link
Contributor

@dellisd It looks like a lot of the optional props are marked as required e.g.

/** If true the compass button is included. */
showCompass: boolean;

// instead of
showCompass?: boolean;

Source

I assume this was just because they were copied that way from the flow types? Do you think there would be any issues if I changed them?

@dellisd
Copy link
Contributor Author

dellisd commented Jul 5, 2022

Yeah I think I missed it while copying the flow types. There shouldn't be any issues changing them.

@josh-cloudscape
Copy link
Contributor

I've created a PR #378

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.

3 participants