@zuke/openapi-ts
`@zuke/openapi-ts` — typed `openapi-ts` task wrappers for Zuke builds.
@zuke/openapi-ts on JSR ↗ 3 symbols
Symbols
class OpenapiTsGenerateSettings extends ToolSettings Settings for an openapi-ts generation run.
| Member | Signature | Doc |
|---|---|---|
input | input(value: PathLike): this | OpenAPI specification to read — a file path or URL (--input). |
output | output(value: PathLike): this | Directory the generated client is written to (--output). |
client | client(value: string): this | HTTP client to generate for, e.g. @hey-api/client-fetch (--client). |
file | file(value: PathLike): this | Configuration file to load settings from (--file). |
dryRun | dryRun(): this | Print the planned output without writing any files (--dry-run). |
watch | watch(): this | Regenerate on changes to the specification (--watch). |
silent | silent(): this | Suppress informational logging (--silent). |
const OpenapiTsTasks: OpenapiTsTasksApi Typed task functions for the Hey API openapi-ts code generator.
interface OpenapiTsTasksApi The shape of OpenapiTsTasks.
| Member | Signature | Doc |
|---|---|---|
generate | generate(configure?: Configure<OpenapiTsGenerateSettings>): Promise<CommandOutput> | Generate a type-safe API client from an OpenAPI spec with openapi-ts. |