Options

Options for pluginReactQuery, with type and default in the table.

Option	Type	Default	Description
output	Output	{ path: 'hooks', barrel: { type: 'named' } }	Where the generated hooks are written and exported
group	Group	—	Split output into per-tag or per-path folders
client	'axios' | 'fetch'	—	Which registered client plugin the hooks call
infinite	Partial<Infinite> | false	false	Generate useInfiniteQuery hooks for pagination
suspense	Partial<object> | false	{}	Generate useSuspenseQuery hooks
query	Partial<Query> | false	{ methods: ['GET'], … }	Configure the query hooks
queryKey	(props) => unknown[]	built-in	Build the queryKey for each query hook
mutation	Partial<Mutation> | false	{ methods: ['POST', 'PUT', 'PATCH', 'DELETE'], … }	Configure the mutation hooks
mutationKey	(props) => unknown[]	built-in	Build the mutationKey for each mutation hook
customOptions	CustomOptions	—	Route every hook through your own options function
hooks	boolean	false	Emit use* hook functions on top of the factories
resolver	Partial<ResolverReactQuery>	—	Customize generated names and file paths
macros	Array<Macro>	—	Rewrite AST nodes before printing
include	Array<Include>	—	Keep only operations that match
exclude	Array<Exclude>	—	Skip operations that match
override	Array<Override>	—	Apply different options per pattern

output

Where the generated hooks are written and exported.

output.path

Folder for the plugin's files, resolved against the global output.path and defaulting to 'hooks'. With output.mode: 'file', use a filename like 'hooks.ts'.

output.mode

'directory' (the default) writes one file per operation. 'file' writes a single file whose output.path includes the extension, and cannot be combined with group.

output.barrel

Toggle the export style and depth to see the generated barrels.

• src/gen/
• models/
• Pet.ts
• User.ts
• clients/
• pet/
• getPetById.ts
• store/
• getInventory.ts

src/gen/index.ts

Controls how the generated index.ts (barrel) re-exports the output. Defaults to { type: 'named' }, and also accepts { type: 'all' }, { nested: true }, or false.

output.banner

Text added to the top of every file, for license headers or @ts-nocheck. Pass a string, or a function of a BannerMeta object for per-file control.

output.footer

Same as banner but added to the bottom of every file.

group

Switch the mode to see where these operations land on disk.

clients/pet/

• getPetById
• addPet

clients/store/

• getInventory

clients/order/

• placeOrder
• getOrderById

clients/user/

• loginUser

group: { type: "tag" } splits the output by the operation tag, so placeOrder follows its order tag.

Splits generated files into per-tag or per-path subfolders under {output.path}/{groupName}/. Applies only to output.mode: 'directory'.

group.type

Assigns each operation to a group, required when group is set. 'tag' uses the first tag and 'path' the first URL segment. Untagged operations use default.

group.name

Turns a group key into a folder name, defaulting to the camelCased tag, or the first URL segment for path groups.

client

Which registered client plugin the hooks call, 'axios' or 'fetch'. When omitted, a single registered client plugin is auto-detected, so it is only needed to disambiguate several.

NOTE

The hooks call a client plugin's functions, so register @kubb/plugin-axios or @kubb/plugin-fetch alongside this one.

infinite

Adds infinite-query output for pagination. Pass an object to configure the cursor, or false (the default) to skip. Emitted only for operations with a query parameter matching infinite.queryParam, and hooks wraps it in useInfiniteQuery.

infinite.queryParam

Query parameter that carries the page cursor, defaulting to 'id'.

infinite.initialPageParam

Initial value for pageParam on the first fetch, defaulting to 0.

infinite.nextParam

Path to the next-page cursor, as dot notation ('pagination.next.id') or array form. Defaults to null.

infinite.previousParam

Path to the previous-page cursor, in the same forms. Defaults to null.

suspense

Adds a suspense variant alongside the regular query output, on by default. Set false to skip it, or hooks to wrap it in useSuspenseQuery. TanStack Query v5+ only.

query

Which operations become queries, emitting a queryOptions factory by default. Pass false to skip, or hooks to also emit useQuery.

query.methods

HTTP methods treated as queries, defaulting to ['GET'].

query.importPath

Module for the queryOptions import, defaulting to '@tanstack/react-query'.

queryKey

Builds the queryKey for each hook from the operation node and casing, defaulting to the built-in queryKeyTransformer. String values are inlined verbatim, so wrap literals in JSON.stringify(...).

mutation

Which operations become mutations, emitting a mutationOptions factory by default. Set false to skip, or hooks to also emit useMutation.

mutation.methods

HTTP methods treated as mutations, defaulting to ['POST', 'PUT', 'PATCH', 'DELETE'].

mutation.importPath

Module for the mutationOptions import, defaulting to '@tanstack/react-query'.

mutationKey

Builds the mutationKey for each mutation hook, for batched invalidations or useMutationState. Same props and string-inlining caveat as queryKey, defaulting to the built-in mutationKeyTransformer.

customOptions

Routes every hook through your own function that returns extra options such as onSuccess or select. Also emits a HookOptions type so your wrapper stays in sync.

customOptions.importPath

Module of your custom-options hook, imported as a named import. Required when customOptions is set.

customOptions.name

Exported name of your custom-options hook, defaulting to 'useCustomHookOptions'.

hooks

When false (the default), only the adapter-portable factory helpers are written. Set true to also generate useQuery, useSuspenseQuery, useInfiniteQuery, useSuspenseInfiniteQuery, and useMutation.

resolver

Changes how generated files and symbols are named. Override only the methods you want, and the rest keep resolverReactQuery. See Override a resolver for the this context and this.name(name).

macros

Rewrites AST nodes before they are printed. Each macro callback receives a node and returns a replacement, or undefined to keep it.

include

Generates only operations matching at least one entry, filtered by tag, operationId, path, method, contentType, or schemaName. pattern is a string (exact) or RegExp (fuzzy).

exclude

Skips any operation matching at least one entry, the opposite of include. Same filter kinds and pattern, and exclude wins when both match.

override

Applies different options to operations matching a pattern. Each entry adds an options object that accepts any option except override, so rules cannot nest. The first matching entry wins.