Output Configuration

The output option controls where generated files are written and how they’re formatted.

Basic Usage

The simplest form is a string path:

openapi-ts.config.ts

export default defineConfig({
  input: 'https://api.example.com/openapi.json',
  output: './src/client',
});

For more control, use an object:

openapi-ts.config.ts

export default defineConfig({
  input: 'https://api.example.com/openapi.json',
  output: {
    path: './src/client',
    clean: true,
    postProcess: ['prettier', 'eslint'],
  },
});

Output Options

string

required

The absolute or relative path to the output folder where generated files will be written.

boolean

default:true

Clean the output folder before generating new files.When enabled, the entire output directory is deleted before generation. If disabled, new files are written alongside existing files, which may be useful if you’re storing additional custom files in the output directory.

export default defineConfig({
  output: {
    path: './src/client',
    clean: false, // Keep existing files
  },
});

boolean

default:true

Generate an entry file (typically index.ts) that re-exports symbols from other generated files.This provides a single import point for consumers:

// With entryFile: true
import { getUsersOptions, type User } from './client';

// With entryFile: false
import { getUsersOptions } from './client/services.gen';
import type { User } from './client/types.gen';

array

default:[]

Post-processing commands to run on the output folder, executed in order.Use preset strings for common tools, or provide custom configurations.Available presets:

'biome:format' — Format with Biome
'biome:lint' — Lint with Biome
'eslint' — Lint and fix with ESLint
'oxfmt' — Format with Oxfmt
'oxlint' — Lint and fix with Oxlint
'prettier' — Format with Prettier

export default defineConfig({
  output: {
    path: './src/client',
    postProcess: ['prettier', 'eslint'],
  },
});

export default defineConfig({
  output: {
    path: './src/client',
    postProcess: [
      { 
        command: 'dprint', 
        args: ['fmt', '{{path}}'] 
      },
    ],
  },
});

export default defineConfig({
  output: {
    path: './src/client',
    postProcess: [
      'prettier',
      { 
        command: 'custom-tool', 
        args: ['--fix', '{{path}}'] 
      },
    ],
  },
});

The {{path}} placeholder is replaced with the output directory path.

string

Defines casing of output fields. By default, we preserve input values as data transforms incur a performance penalty at runtime.Options: 'camelCase', 'PascalCase', 'snake_case', 'preserve'

export default defineConfig({
  output: {
    path: './src/client',
    case: 'camelCase',
  },
});

string | object

Transform file names before they are created.

Show File Name Configuration

string

default:"preserve"

Casing convention for file names: 'camelCase', 'PascalCase', 'kebab-case', 'snake_case', 'preserve'

string | function

default:"{{name}}"

Naming pattern or function for file names. Use {{name}} placeholder for the original name.

string | null

default:".gen"

Suffix to append to file names (before the extension). Set to null to disable.Examples:

With suffix .gen: types.ts → types.gen.ts
With suffix null: types.ts → types.ts

export default defineConfig({
  output: {
    path: './src/client',
    fileName: {
      case: 'kebab-case',
      suffix: '.generated',
    },
  },
});

boolean

default:false

Use export * from 'module' instead of named exports when possible.This can reduce bundle size but may affect tree-shaking.

string

File extension to use when importing other modules. By default, no extension is added.If you’re using moduleResolution: "nodenext" or "node16", this defaults to .js.

export default defineConfig({
  output: {
    path: './src/client',
    importFileExtension: '.js',
  },
});

Generated imports will look like:

import { User } from './types.gen.js';

string

Path to the tsconfig.json file to use for generating output.If not provided, we attempt to find one starting from the config file location and traversing up.

string | function

Text to include at the top of every generated file.

export default defineConfig({
  output: {
    path: './src/client',
    header: '// This file is auto-generated. Do not edit manually.',
  },
});

export default defineConfig({
  output: {
    path: './src/client',
    header: (ctx) => [
      '// Auto-generated by OpenAPI TypeScript',
      `// Generated at: ${new Date().toISOString()}`,
    ],
  },
});

boolean | object

default:false

Generate a copy of the input OpenAPI specification alongside the output.Set to true to use defaults, or provide a configuration object.

export default defineConfig({
  output: {
    path: './src/client',
    source: true, // Generates openapi.json in output directory
  },
});

Deprecated Options

The following options are deprecated and will be removed in a future version.

string

default:null

Deprecated: Use postProcess instead.Which formatter to use: 'biome' or 'prettier'.

string

default:null

Deprecated: Use postProcess instead.Which linter to use: 'biome', 'eslint', or 'oxlint'.

boolean

default:true

Deprecated: Use entryFile instead.Generate an index file that re-exports symbols.

Multiple Outputs

Generate multiple outputs from the same input:

openapi-ts.config.ts

import { defineConfig } from '@hey-api/openapi-ts';

export default defineConfig({
  input: 'https://api.example.com/openapi.json',
  output: [
    {
      path: './src/client/v1',
      postProcess: ['prettier'],
    },
    {
      path: './src/client/v2',
      postProcess: ['biome:format'],
    },
  ],
});

Or pair multiple inputs with multiple outputs:

openapi-ts.config.ts

import { defineConfig } from '@hey-api/openapi-ts';

export default defineConfig({
  input: [
    'https://api.example.com/v1/openapi.json',
    'https://api.example.com/v2/openapi.json',
  ],
  output: [
    './src/client/v1',
    './src/client/v2',
  ],
});

Post-Processing

The postProcess option runs commands after files are generated. This is useful for formatting and linting:

openapi-ts.config.ts

import { defineConfig } from '@hey-api/openapi-ts';

export default defineConfig({
  output: {
    path: './src/client',
    postProcess: [
      'oxfmt',      // Format first
      'eslint',     // Then lint and fix
    ],
  },
});

Commands are executed in order, and {{path}} is replaced with the output directory:

postProcess: [
  { command: 'prettier', args: ['--write', '{{path}}'] },
  { command: 'eslint', args: ['{{path}}', '--fix'] },
]

Get Started

Configuration

Core Plugins

HTTP Clients

Validators

State Management

Web Frameworks

Advanced

Basic Usage

Output Options

Deprecated Options

Multiple Outputs

Post-Processing

​Basic Usage

​Output Options

​Deprecated Options

​Multiple Outputs

​Post-Processing

Basic Usage

Output Options

Deprecated Options

Multiple Outputs

Post-Processing