-
-
Notifications
You must be signed in to change notification settings - Fork 388
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
docs(readme): add types #903
docs(readme): add types #903
Conversation
README.md
Outdated
Type: | ||
|
||
```ts | ||
type insert = string | ((linkTag: any) => void); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please avoid using any
, if you found it in our code, it means bug, we should improve this type
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The linkTag here is an HTMLElement
right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't know, but mostly yes, just check it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed to HTMLLinkElement
or | ||
|
||
```console | ||
yarn add -D mini-css-extract-plugin |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change it on npm
, because we use npm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we want to provide yarn, we should also provide pnpm example, i.e. for all package managers
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🤔 I've seen npm and yarn in some repos. That is why I started adding yarn in all repos. Should we consider adding pnpm
as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we add yarn
we should add pnpm
too
Codecov Report
@@ Coverage Diff @@
## master #903 +/- ##
=======================================
Coverage 90.29% 90.29%
=======================================
Files 5 5
Lines 824 824
Branches 220 220
=======================================
Hits 744 744
Misses 70 70
Partials 10 10
Continue to review full report at Codecov.
|
Thanks |
This PR contains a:
Motivation / Use-Case
Added types in Readme