Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding allowUndefinedQueryVariables option to typescript-operations plugin #9652

Merged

Conversation

gmurphey
Copy link
Contributor

Description

For libraries like react-query, there is the option to disable a query if there is a dependency that hasn't been met. For example:

query getAuthUsers($userId: uuid!) {
  authentication_users(where: { uuid: { _eq: $userId } }) {
    uuid
  }
}
type Props = {
  userId: string | undefined;
}

...

const { data } = useGetAuthUsers({ userId }, { enabled: Boolean(userId) });

Unfortunately, this fails typechecking because the variables for the hook are defined as Exact<{ userId: string>. I'd like to be able to do something like the following.

const { data }  = useGetAuthUsers(userId ? { userId } : undefined, { enabled: Boolean(userId) });

This disables the query and maintains type safety.

This PR adds the ability to set allowUndefinedQueryVariables (boolean) in a codegen config to add a union to query variable types to allow them to be undefined.

Related #6124

Type of change

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Added a Jest test to the typescript-operations plugin.

Checklist:

  • I have followed the CONTRIBUTING doc and the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@changeset-bot
Copy link

changeset-bot bot commented Aug 28, 2023

🦋 Changeset detected

Latest commit: 2324773

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages
Name Type
@graphql-codegen/visitor-plugin-common Minor
@graphql-codegen/typescript-operations Minor
@graphql-codegen/typescript-document-nodes Patch
@graphql-codegen/gql-tag-operations Patch
@graphql-codegen/typescript-resolvers Patch
@graphql-codegen/typed-document-node Patch
@graphql-codegen/typescript Patch
@graphql-codegen/graphql-modules-preset Patch
@graphql-codegen/client-preset Patch

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

@saihaj
Copy link
Collaborator

saihaj commented Feb 20, 2024

thanks!

@saihaj saihaj merged commit 920b443 into dotansimha:master Feb 20, 2024
11 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants