@zuke/openapi-ts

← API reference

`@zuke/openapi-ts` — typed `openapi-ts` task wrappers for Zuke builds.

Symbols

# OpenapiTsGenerateSettings class
class OpenapiTsGenerateSettings extends ToolSettings

Settings for an openapi-ts generation run.

MemberSignatureDoc
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).
# OpenapiTsTasks const
const OpenapiTsTasks: OpenapiTsTasksApi

Typed task functions for the Hey API openapi-ts code generator.

# OpenapiTsTasksApi interface
interface OpenapiTsTasksApi

The shape of OpenapiTsTasks.

MemberSignatureDoc
generate generate(configure?: Configure<OpenapiTsGenerateSettings>): Promise<CommandOutput> Generate a type-safe API client from an OpenAPI spec with openapi-ts.