@kubb/plugin-ts

@kubb/plugin-ts turns your OpenAPI schemas into TypeScript types and interfaces that other Kubb plugins build on. Clients, query hooks, mocks, and validators reuse the names it generates, so every request, response, parameter, and enum is checked at compile time.

Installation ​

bun add -d @kubb/plugin-ts

pnpm add -D @kubb/plugin-ts

npm install --save-dev @kubb/plugin-ts

yarn add -D @kubb/plugin-ts

Dependencies ​

@kubb/plugin-ts has no plugin dependencies. It reads the OpenAPI spec through @kubb/adapter-oas, so add it whenever a client, query, mock, or validator plugin needs typed output.

Example ​

import { defineConfig } from 'kubb'
import { pluginTs } from '@kubb/plugin-ts'

export default defineConfig({
  input: './petStore.yaml',
  output: { path: './src/gen' },
  plugins: [
    pluginTs({
      output: { path: './types', mode: 'directory' },
      exclude: [{ type: 'tag', pattern: 'store' }],
      group: { type: 'tag' },
      enum: { type: 'asConst' },
      optionalType: 'questionTokenAndUndefined',
    }),
  ],
})

See also ​

• TypeScript
• TypeScript Compiler API
• Changelog