Configuration

This page is a reference to the different ways of configuring your Orval projects.

Using an orval.config.(js|mjs|ts) configuration file, placed at the root of a project, you can provide a list of options that changes the default behaviour of the Orval generated files.

Configuration options for the following are described on this page:

orval.config.js

1 module.exports = {
2   petstore: {
3     input: './petstore.yaml',
4     output: './petstore.ts',
5     hooks: {
6       afterAllFilesWrite: 'prettier --write',
7     },
8   },
9 };

orval.config.ts

1 import { defineConfig } from 'orval';
2 
3 export default defineConfig({
4   petstore: {
5     input: './petstore.yaml',
6     output: './petstore.ts',
7     hooks: {
8       afterAllFilesWrite: 'prettier --write',
9     },
10   },
11 });