fix type checking when strictNullChecks is disabled
#1833
Merged
Conversation
This file contains hidden or 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
🦋 Changeset detectedLatest commit: ea2c26b The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
ngraef
commented
Aug 9, 2024
| --- | ||
| "openapi-typescript-helpers": patch | ||
| "openapi-react-query": patch | ||
| "openapi-fetch": patch |
There was a problem hiding this comment.
I view this as a bug fix that implements the expected behavior. However, it does have the potential to break type checking in projects with incorrect code, so I can change this to minor if we want to be safe.
kerwanp
added
openapi-ts
drwpow
approved these changes
Aug 10, 2024
|
Shoot looks like another PR merged before this caused some conflicts. Once the conflicts are resolved, happy to merge & release. |
…disabled # Conflicts: # packages/openapi-fetch/src/index.d.ts
ngraef
force-pushed
the
fix-required-params
branch
from
8e46c42 to
ea2c26b
Compare
This was referenced Aug 12, 2024
Merged
Merged
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.
Changes
This PR refactors some types to remove usage of
undefined extends Tconditional types. It also adds a new test suite that is type checked withstrictNullChecksdisabled to allow for increased support of that configuration.Resolves #1778
How to Review
See context in this comment on the issue. Using
undefined extends Tonly behaves as expected whenstrictNullChecksis enabled. While this configuration is highly recommended for consuming projects, it is not the default, and we should design types that also work without it when possible.#1778 describes a case where
paramsis required on calls to routes with no parameters defined or no required parameters in the spec. At least two other cases are caused by the same underlying issue:paramsis not required, regardless of whether any of the parameters are required in the spec.bodyproperty is not required on calls to routes with a required request body defined in the spec.This PR fixes the behavior of those cases.
Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript)