Fix request types for use with Node #578
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When using Ky with Node, TypeScript will run into compilation error regarding types required by `UndiciRequestInit`. This is because `@types/node` does not yet provide these types, and they are not imported from `undici-types` either. The latter would not even be possible to keep Ky usable with browsers. This happened to work in the project, because `@sindresorhus/tsconfig` includes `DOM` in the libs section. In most Node applications, the DOM lib should not be there and clashes with Node types. One way to circumvent this is to add `skipLibCheck: true` to `tsconfig.json`, but this is not a good solution. This commit adds the needed types until `@types/node` imports the missing types and adds them to globals. After that, all "Undici" types from the request types should be removed.
|
Here is an example of a project not compiling because of the issue fixed in this PR. |
Can you open an issue on the TS types repo and add a code comment with the link? I like to know that it will eventually be resolved upstream. |
Add link to DefinitelyTyped issue with missing exported globals.
|
@sindresorhus done, I opened a discussion here: DefinitelyTyped/DefinitelyTyped#69408 Code comment also added. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When using Ky with Node, TypeScript will run into compilation error regarding types required by
UndiciRequestInit. This is because@types/nodedoes not yet provide these types, and they are not imported fromundici-typeseither. The latter would not even be possible to keep Ky usable with browsers.This happened to work in the project, because
@sindresorhus/tsconfigincludesDOMin the libs section. In most Node applications, the DOM lib should not be there and clashes with Node types. One way to circumvent this is to addskipLibCheck: truetotsconfig.json, but this is not a good solution.This commit adds the needed types until
@types/nodeimports the missing types and adds them to globals. After that, all "Undici" types from the request types should be removed.