Make types compatible with both DOM and Node.js #543
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
alecmev
changed the title
NormalizedOptions
alecmev
commented
Nov 12, 2023
| @@ -175,7 +175,7 @@ export class Ky { | |||
| this._options.duplex = 'half'; | |||
| } | |||
|
|
|||
| this.request = new globalThis.Request(this._input as RequestInfo, this._options as RequestInit); | |||
There was a problem hiding this comment.
Doesn't appear to be needed?
| @@ -177,7 +178,7 @@ export type KyOptions = { | |||
| const json = await ky('https://example.com', {fetch}).json(); | |||
| ``` | |||
| */ | |||
| fetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>; | |||
There was a problem hiding this comment.
This is breaking, but actually both @types/node and lib.dom.d.ts define it this way.
Comment on lines
+255
to
+256
| method: NonNullable<RequestInit['method']>; | ||
| credentials: NonNullable<RequestInit['credentials']>; |
There was a problem hiding this comment.
exactOptionalPropertyTypes: true fails on this, as optional properties get resolved as Foo | undefined, and that isn't compatible with RequestInit.
|
I'm unable to publish this until #544 is figured out. |
|
That's alright, thanks for taking a look! |
alecmev
added a commit
to alecmev/ky
that referenced
this pull request
Mar 21, 2024
sindresorhus#559 undid the fix in sindresorhus#543.
alecmev
added a commit
to alecmev/ky
that referenced
this pull request
Mar 21, 2024
sindresorhus#559 undid the fix in sindresorhus#543.
alecmev
added a commit
to alecmev/ky
that referenced
this pull request
Mar 22, 2024
sindresorhus#559 undid the fix in sindresorhus#543. Added `exactOptionalPropertyTypes` to `compilerOptions` to prevent this from happening again, seems pretty low-impact. It should be okay to pass `undefined` to `credentials` and other options, but this is an upstream problem (see `RequestInit` in `undici-types/fetch.d.ts`). The build was failing on TS 5.4 because there's a `priority` in `RequestInit` now.
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.
Otherwise TypeScript fails with
skipLibCheck: false,exactOptionalPropertyTypes: trueand noDOM:Would add a test, but it doesn't seem like there are any type tests. How do you want to go about this?