docs(readme): added types #660
Conversation
Codecov Report
@@ Coverage Diff @@
## master #660 +/- ##
=======================================
Coverage 90.17% 90.17%
=======================================
Files 2 2
Lines 397 397
Branches 119 119
=======================================
Hits 358 358
Misses 38 38
Partials 1 1
Continue to review full report at Codecov.
|
README.md
Outdated
| Type: | ||
|
|
||
| ```ts | ||
| type globOptions = object; |
There was a problem hiding this comment.
Let's use types from globby, just use the same name
There was a problem hiding this comment.
import("globby").Options?
| sourceFilename: string; | ||
| absoluteFilename: string; | ||
| }[] | ||
| ) => any; |
There was a problem hiding this comment.
copy-webpack-plugin/types/index.d.ts
Line 70 in 9b5a314
🤔 Am I looking at the wrong type then 😕
There was a problem hiding this comment.
We should add @returns to types here too, looks like bug on our side
There was a problem hiding this comment.
copy-webpack-plugin/types/index.d.ts
Lines 253 to 259 in 9b5a314
I thought this returned any
| @@ -249,7 +249,7 @@ type TransformerObject = { | |||
| cache?: boolean | TransformerCacheObject | undefined; | |||
| }; | |||
| type Transform = TransformerFunction | TransformerObject; | |||
| type Filter = (filepath: string) => any; | |||
| type Filter = (filepath: string) => boolean; | |||
There was a problem hiding this comment.
We should add this here https://github.com/webpack-contrib/copy-webpack-plugin/blob/master/src/index.js#L95 and run npm run build, same for https://github.com/webpack-contrib/copy-webpack-plugin/blob/master/src/index.js#L99
|
Thanks |
This PR contains a:
Motivation / Use-Case
Changed to typescript types and standardized readme