@zuke/orval

`@zuke/orval` — typed `orval` task wrappers for Zuke builds.

Symbols

# OrvalGenerateSettings class

class OrvalGenerateSettings extends ToolSettings

Settings for an orval generation run.

Member	Signature	Doc
`config`	`config(value: PathLike): this`	Configuration file to load settings from (`-c`/`--config`).
`project`	`project(value: string): this`	Run only the named project from the config (`-p`/`--project`).
`input`	`input(value: PathLike): this`	OpenAPI specification to read — a file path or URL (`-i`/`--input`).
`output`	`output(value: PathLike): this`	Directory the generated client is written to (`-o`/`--output`).
`watch`	`watch(): this`	Regenerate on changes to the specification (`-w`/`--watch`).
`clean`	`clean(): this`	Remove previously generated files before writing (`--clean`).
`prettier`	`prettier(): this`	Format the generated output with Prettier (`--prettier`).
`biome`	`biome(): this`	Format the generated output with Biome (`--biome`).
`mock`	`mock(): this`	Generate mocks alongside the client (`--mock`).

# OrvalTasks const

const OrvalTasks: OrvalTasksApi

Typed task functions for the orval OpenAPI client and mock generator.

# OrvalTasksApi interface

interface OrvalTasksApi

The shape of OrvalTasks.

Member	Signature	Doc
`generate`	`generate(configure?: Configure<OrvalGenerateSettings>): Promise<CommandOutput>`	Generate a TypeScript API client and mocks from an OpenAPI spec with `orval`.