Skip to content

Add types for exported functions. #69

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

Merged

Conversation

maddijoyce
Copy link
Collaborator

What: Update index.d.ts exports to match index.js exports.

Why: A number of functions are missing from index.d.ts (renderIntoDocument, fireEvent, cleanup, waitForElement).

How: Added types to the index.d.ts file.

Checklist:

  • Documentation N/A
  • Tests N/A
  • Ready to be merged
  • Added myself to contributors table

kentcdodds
kentcdodds previously approved these changes May 3, 2018
Copy link
Member

@kentcdodds kentcdodds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @maddijoyce! I don't maintain the TypeScript definitions, but if you'd like to help maintain those I'll add you as a collaborator and merge this 👌

@maddijoyce
Copy link
Collaborator Author

@kentcdodds I'm very happy to maintain the definitions, I'll keep an eye on any changes to the api and update TS to match. And if there are any issues as far as typescript goes, happy to try to resolve those too.

Copy link
Member

@kentcdodds kentcdodds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

@kentcdodds kentcdodds merged commit 0aae0e1 into testing-library:master May 3, 2018
@kentcdodds
Copy link
Member

Thanks so much for your help! I've added you as a collaborator on the project. Please make sure that you review the other/MAINTAINING.md and CONTRIBUTING.md files (specifically the bit about the commit messages and the git hooks) and familiarize yourself with the code of conduct (we're using the contributor covenant). You might also want to watch the repo to be notified when someone files an issue/PR. Please continue to make PRs as you feel the need (you can make your branches directly on the repo rather than your fork if you want). Thanks! And welcome to the team :)

@kentcdodds
Copy link
Member

🎉 This PR is included in version 2.5.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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.

2 participants