> Index of every page on this site: [llms.txt](https://kubb.dev/llms.txt) # Options Pass these options to `pluginTs()`. Shared options link to [Shared plugin options](https://kubb.dev/docs/5.x/reference/plugin-options) for details. ## Options overview | Option | Purpose | Default | | ------------------------------------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | [`output`](https://kubb.dev/docs/5.x/reference/plugin-options#output) | Where files are written: `path`, `mode`, `barrel`, `banner`, `footer`. | `{ path: 'types', barrel: { type: 'named' } }` | | [`group`](https://kubb.dev/docs/5.x/reference/plugin-options#group) | Split output by tag or path: `type`, `name`. | None | | [`enum`](#enum) | How enums are generated and cased. | `{ type: 'asConst', constCasing: 'camelCase', typeSuffix: 'Key', keyCasing: 'none' }` | | [`syntaxType`](#syntaxtype) | Emit object schemas as type aliases or interfaces. | `'type'` | | [`optionalType`](#optionaltype) | How optional properties are written. | `'questionToken'` | | [`arrayType`](#arraytype) | `Type[]` or `Array`. | `'array'` | | [`operations`](#operations) | Emit per-operation types, or print them inline in consumers. | `'export'` | | [`include`](https://kubb.dev/docs/5.x/reference/plugin-options#include) | Keep only operations and schemas that match. | None | | [`exclude`](https://kubb.dev/docs/5.x/reference/plugin-options#exclude) | Skip operations and schemas that match. | `[]` | | [`override`](https://kubb.dev/docs/5.x/reference/plugin-options#override) | Apply different options per pattern. | `[]` | | [`resolver`](#resolver) | Customize generated names and file paths. | `resolverTs` | | [`macros`](https://kubb.dev/docs/5.x/reference/plugin-options#macros) | Rewrite AST nodes before printing. | `[]` | | [`printer`](#printer) | Replace the handler for a schema type. | None | ## Option details ### enum How OpenAPI enums are represented in the generated TypeScript, and how their names are cased. | | | | -------- | ------------------------------------------------------------------------------------- | | Type | `{ type?, constCasing?, typeSuffix?, keyCasing? }` | | Required | `false` | | Default | `{ type: 'asConst', constCasing: 'camelCase', typeSuffix: 'Key', keyCasing: 'none' }` | `constCasing` and `typeSuffix` apply only to `type: 'asConst'`. `keyCasing` applies to `'asConst'`, `'enum'` and `'constEnum'`, since the literal modes emit values only. #### enum.type Representation of each enum. | | | | -------- | -------------------------------------------------------------------- | | Type | `'asConst' \| 'enum' \| 'constEnum' \| 'literal' \| 'inlineLiteral'` | | Required | `false` | | Default | `'asConst'` | ::field-group :::field{name="'asConst'"} Emits an `as const` object and a union type of its values. Bundlers drop the object when nothing uses it. ::: :::field{name="'enum'"} Emits a TypeScript `enum` with JavaScript runtime code. ::: :::field{name="'constEnum'"} Emits a `const enum`, inlined at compile time and incompatible with `--isolatedModules`. ::: :::field{name="'literal'"} Emits a named union type with no runtime value. ::: :::field{name="'inlineLiteral'"} Emits the same union as `'literal'` but inlines it at each usage site instead of naming it. ::: :: ::code-group ```typescript ['asConst' (default)] export const petStatus = { available: 'available', pending: 'pending', sold: 'sold', } as const export type PetStatusKey = (typeof petStatus)[keyof typeof petStatus] ``` ```typescript ['enum'] export enum PetStatus { available = 'available', pending = 'pending', sold = 'sold', } ``` ```typescript ['literal'] export type PetStatus = 'available' | 'pending' | 'sold' ``` :: #### enum.constCasing Casing of the generated const object when `type` is `'asConst'`. | | | | -------- | ----------------------------- | | Type | `'camelCase' \| 'pascalCase'` | | Required | `false` | | Default | `'camelCase'` | ::field-group :::field{name="'camelCase'"} Names the const `petStatus`. ::: :::field{name="'pascalCase'"} Names the const `PetStatus`, matching the schema name. ::: :: #### enum.typeSuffix Suffix on the companion type alias when `type` is `'asConst'`. It never changes the const object name. Set it to `''` to drop the suffix, which with `constCasing: 'pascalCase'` merges the const and the type under one name, `PetStatus`. | | | | -------- | -------- | | Type | `string` | | Required | `false` | | Default | `'Key'` | ```typescript [typeSuffix: 'Value'] export type PetStatusValue = (typeof petStatus)[keyof typeof petStatus] ``` #### enum.keyCasing Casing applied to enum key names. | | | | -------- | ------------------------------------------------------------------------------ | | Type | `'none' \| 'camelCase' \| 'pascalCase' \| 'snakeCase' \| 'screamingSnakeCase'` | | Required | `false` | | Default | `'none'` | ::field-group :::field{name="'none'"} Keeps the raw enum value from the spec as the key. ::: :::field{name="'camelCase'"} Formats keys as `enumValue`. ::: :::field{name="'pascalCase'"} Formats keys as `EnumValue`. ::: :::field{name="'snakeCase'"} Formats keys as `enum_value`. ::: :::field{name="'screamingSnakeCase'"} Formats keys as `ENUM_VALUE`. ::: :: ### syntaxType How object schemas are declared. | | | | -------- | ----------------------- | | Type | `'type' \| 'interface'` | | Required | `false` | | Default | `'type'` | ::field-group :::field{name="'type'"} Generates type aliases, `export type Pet = { name: string }`. ::: :::field{name="'interface'"} Generates interface declarations, `export interface Pet { name: string }`. Use it when consumers need declaration merging. See [Type vs Interface](https://www.totaltypescript.com/type-vs-interface-which-should-you-use). ::: :: ### optionalType How optional properties are written. | | | | -------- | --------------------------------------------------------------- | | Type | `'questionToken' \| 'undefined' \| 'questionTokenAndUndefined'` | | Required | `false` | | Default | `'questionToken'` | ::field-group :::field{name="'questionToken'"} Writes `type?: string`, so the property may be missing. ::: :::field{name="'undefined'"} Writes `type: string | undefined`, so it must exist but may be `undefined`. ::: :::field{name="'questionTokenAndUndefined'"} Writes `type?: string | undefined`, so the property may be missing or `undefined`. Use it with `"exactOptionalPropertyTypes": true`. ::: :: ### arrayType Syntax for array types. | | | | -------- | ---------------------- | | Type | `'array' \| 'generic'` | | Required | `false` | | Default | `'array'` | ::field-group :::field{name="'array'"} Uses the postfix `tags: string[]`. ::: :::field{name="'generic'"} Uses `tags: Array`, which reads better for complex elements like `Array<{ id: number }>`. ::: :: ### operations Whether each operation gets its own types file (`AddPetOptions`, `AddPetResponses`, `AddPetStatus200`, `AddPetPath`). | | | | -------- | ---------------------- | | Type | `'export' \| 'inline'` | | Required | `false` | | Default | `'export'` | ::field-group :::field{name="'export'"} Emits one file per operation with its aliases and aggregates, for example `export type AddPetStatus200 = Pet`. ::: :::field{name="'inline'"} Emits only the schema types. Clients, query hooks, MSW handlers, Faker mocks, Cypress requests, and MCP handlers reference those directly and print the rest inline, for example `Options<{ body: Order; path?: never; query?: never; headers?: never }>` and `mutationOptions, …>`. An enum declared inside an operation becomes a literal union such as `'available' | 'pending' | 'sold'`. Kubb moves each operation type into the files that use it, so this needs a Kubb version with inline sources. ::: :: ### resolver Overrides generated file and symbol names. Omitted members keep `resolverTs`. The shared members (`name`, `file`, `imports`) and the `this` context are described under [`resolver`](https://kubb.dev/docs/5.x/reference/plugin-options#resolver). | | | | -------- | --------------------------- | | Type | `ResolverPatch` | | Required | `false` | ::code-collapse{name="ResolverTs patch members"} ```typescript [Partial override] type ResolverTsPatch = { // plus the shared name, file, and imports members param?: { name?(node: OperationNode, param: ParameterNode): string // → 'DeletePetPathPetId' path?(node: OperationNode, param: ParameterNode): string // → 'GetPetByIdPath' query?(node: OperationNode, param: ParameterNode): string // → 'FindPetsByStatusQuery' headers?(node: OperationNode, param: ParameterNode): string // → 'DeletePetHeaders' } response?: { status?(node: OperationNode, statusCode: StatusCode): string // → 'ListPetsStatus200' options?(node: OperationNode): string // → 'ListPetsOptions' responses?(node: OperationNode): string // → 'ListPetsResponses' response?(node: OperationNode): string // → 'ListPetsResponse' body?(node: OperationNode): string // → 'CreatePetBody' } enum?: { keyName?(node: { name?: string | null }, enumTypeSuffix?: string): string // → 'PetStatusKey' } } ``` :: ### printer Replaces the node handler for a schema type such as `'integer'` or `'date'` with one that builds its TypeScript AST node. Use `this.transform` to recurse into nested nodes and `this.options` to read printer options. The [printer guide](https://kubb.dev/docs/5.x/how-to/printers) covers the handler context and how overrides compose with macros. | | | | -------- | ---------------------------- | | Type | `{ nodes?: PrinterTsNodes }` | | Required | `false` | See [Map schema types](https://kubb.dev/extensions/kubb-labs/plugin-ts/guides/customization#map-schema-types) for an example. ## Sitemap See the full [sitemap](https://kubb.dev/sitemap.md) for all pages.