Add name builder options to TanStack Query

[mrlubos]

Discussed in https://github.com/orgs/hey-api/discussions/2084

^{Originally posted by TCLNA May 28, 2025}
When generating a POST query that is effectively a search endpoint with a lot of options passed in the body, it generates a mutation. Is there a whitelist system for changing the generator behavior for this specific endpoint ? I tried to look at query-core but only found some config boolean flags.
If this does not exist i'm willing to put in the work btw.
Thanks a lot in advance! This is a great project that spared me do much time 🥹

[nickgraffis]

It says this in the docs, and it creates the options to be used in a query.

const query = useQuery({
  ...postLoansOptions({
    body: {
      query: {
        op: 'eq',
        args: { property: 'zipCode', value: '90815' },
      },
    },
  }),
});

just figured it out 😉 , hope it helps

[mrlubos]

@TCLNA can you share your spec with me?

[mrlubos]

@nickgraffis are the docs regarding this feature confusing?

[nickgraffis]

No the docs are super clear, this was my fault.

I didn't really read the docs at first and because there is a addPetMutation I assumed that there would be an addPetQuery, but it is actually addPetOptions.

For example.

This seems to be working perfectly. Thanks for all the hard work.

[mrlubos]

Hmm, that's a fair point, I might (add an option allowing you to) rename it. Is the original account that started the discussion your alt btw or is that another person? Just so I know whether to close this issue

[nickgraffis]

@mrlubos nope not alternate, different person.

Rename it could be a cool option, but having said that, the docs are really clear, I just didn't read them carefully.

[TCLNA]

Hey ! Sorry for the late response.

Thanks for pointing this out @nickgraffis ! I indeed just had a hard time finding the option function name, I wasn't careful enought reading the docs too.