typescript-msw: Correct compatibility with msw@^2 #594
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
🦋 Changeset detectedLatest commit: 0734371 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
lachieh
changed the title
Parameters<typeof> with types from msw@^2.0.0 * BREAKING: Use generated DocumentNodes instead of operation name string for query/mutation parameters
lachieh
changed the title
* Add peerDependency for msw@^2.0.0 * BREAKING: Replace `Parameters<typeof>` with types from msw@^2.0.0 Signed-off-by: Lachlan Heywood <lachieh@users.noreply.github.com>
saihaj
approved these changes
Feb 2, 2024
|
thank you! |
|
@saihaj no problems! Where does the documentation live? I can update that also for when the release goes out. |
|
Package published @graphql-codegen/typescript-msw@3.0.0 Docs live in main repo -> https://github.com/dotansimha/graphql-code-generator/tree/master/website |
|
Thank you! Updating the docs now |
8 tasks
|
@saihaj docs are updated in: dotansimha/graphql-code-generator#9834 |
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.
Description
The
@graphql-codegen/typescript-mswplugin is not fully compatible withmsw@^2.0.0.Related #563, #468
Type of change
Please delete options that are not relevant.
expected)
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can
reproduce. Please also list any relevant details for your test configuration
Test Environment:
Checklist:
CONTRIBUTING doc and the
style guidelines of this project
Further comments
Previously, #468 was closed via #484 by resolving the types using the
Parameters<...>type. Whilethis kept backwards compatibility for
msw@^1, it doesn't fully work withmsw@^2. Specifically,in
msw@^1, the resolver callback was passed aResponseobject which could be invoked with theres.once()method while inmsw@^2, the response must be a nativeHttpReponseobject and theoncemethod is now replaced by theonceproperty on a secondoptionsparameter.This PR adds the second
optionsparameter to the resolver callback and updates the types to becompatible with
msw@^2. This is a breaking change formsw@^1users. If it is desirable, I canadd a new plugin option to allow users to choose between the two major versions of
msw.