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 examples for the built-in types mentioned in the readme #9

Closed
sindresorhus opened this issue Mar 14, 2019 · 5 comments · Fixed by #35
Closed

Add examples for the built-in types mentioned in the readme #9

sindresorhus opened this issue Mar 14, 2019 · 5 comments · Fixed by #35
Labels
🎁 Rewarded on Issuehunt This issue has been rewarded on Issuehunt good first issue Good for newcomers help wanted Extra attention is needed

Comments

@sindresorhus
Copy link
Owner

sindresorhus commented Mar 14, 2019

Issuehunt badges

I made a section in the readme for useful built-in types that many TS devs don't know about. Would be useful to also include some real-world examples of those types in use. It's hard to realize when they would be useful just from their description.

https://github.com/sindresorhus/type-fest#built-in-types

To resolve this issue you should at least add one realistic example for each type.


IssueHunt Summary

krnik krnik has been rewarded.

Backers (Total: $60.00)

Submitted pull Requests


Tips


IssueHunt has been backed by the following sponsors. Become a sponsor

Upvote & Fund

  • We're using Polar.sh so you can upvote and help fund this issue.
  • The funding will be given to active contributors.
  • Thank you in advance for helping prioritize & fund our backlog.
Fund with Polar
@sindresorhus sindresorhus added help wanted Extra attention is needed good first issue Good for newcomers labels Mar 14, 2019
@IssueHuntBot
Copy link

@IssueHunt has funded $60.00 to this issue.


@Keraito
Copy link

Keraito commented Mar 21, 2019

Hey, I would like to give this a shot! A few questions tho:

  1. Can examples, based on the context, also be for certain frameworks like React? Or do they have to be for JS/Node?
  2. How do you want the examples to be included? Just suffix the list items of "Built-in types" with [examples](link/to/ts-playground) ?
  3. Regarding IssueHunt, should I have one 'final' PR or is it alright to divide the examples over different PRs?

@sindresorhus
Copy link
Owner Author

  1. Sure, but should be something most people are familiar with like Node.js/React/etc.
  2. I was thinking just a code block inside a <detail> to toggle it, but a playground is good too, as long as it's focused and doesn't include too much unrelated code.
  3. IssueHunt-wise it would be best with one PR.

@issuehunt-oss issuehunt-oss bot added the 💵 Funded on Issuehunt This issue has been funded on Issuehunt label May 10, 2019
@issuehunt-oss
Copy link

issuehunt-oss bot commented Sep 14, 2019

@sindresorhus has rewarded $54.00 to @krnik. See it on IssueHunt

  • 💰 Total deposit: $60.00
  • 🎉 Repository reward(0%): $0.00
  • 🔧 Service fee(10%): $6.00

@issuehunt-oss issuehunt-oss bot added 🎁 Rewarded on Issuehunt This issue has been rewarded on Issuehunt and removed 💵 Funded on Issuehunt This issue has been funded on Issuehunt labels Sep 14, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🎁 Rewarded on Issuehunt This issue has been rewarded on Issuehunt good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants