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 JSDoc based types #6

Merged
merged 3 commits into from
Apr 19, 2021
Merged

Add JSDoc based types #6

merged 3 commits into from
Apr 19, 2021

Conversation

wooorm
Copy link
Member

@wooorm wooorm commented Apr 14, 2021

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and couldn’t find anything (or linked relevant results below)
  • If applicable, I’ve added docs and tests

Description of changes

This adds types through JSDoc comments.

I’m raising this as a PR because it does not use generics, which are available in the current .d.ts, which seem quite useful in u. Maybe the JSDoc can be improved, or this is a case where a .d.ts file is preferred

@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Apr 14, 2021
@wooorm wooorm added ☂️ area/types This affects typings 💬 type/discussion This is a request for comments and removed 🤞 phase/open Post is being triaged manually labels Apr 14, 2021
@github-actions

This comment has been minimized.

@wooorm wooorm added the 🤞 phase/open Post is being triaged manually label Apr 14, 2021
index.js Outdated Show resolved Hide resolved
types/index.d.ts Show resolved Hide resolved
index.js Outdated Show resolved Hide resolved
index.test-d.ts Show resolved Hide resolved
@wooorm wooorm merged commit a8f3bda into main Apr 19, 2021
@wooorm wooorm deleted the jsdoc-types branch April 19, 2021 07:01
@github-actions github-actions bot added 🤷 no/invalid This cannot be acted upon 👎 phase/no Post cannot or will not be acted on and removed 🤞 phase/open Post is being triaged manually labels Apr 19, 2021
@wooorm wooorm added the 💪 phase/solved Post is done label Apr 19, 2021
@github-actions github-actions bot removed 👎 phase/no Post cannot or will not be acted on 🤷 no/invalid This cannot be acted upon labels Apr 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
☂️ area/types This affects typings 💪 phase/solved Post is done 💬 type/discussion This is a request for comments
Development

Successfully merging this pull request may close these issues.

3 participants