interface OpenApiCodegenOptions

Options for generateOpenApiClient.

Properties

readonly
optional
factoryName: string

Name of the exported factory function. Defaults to 'createApi'.

readonly
optional
sdkImport: string

Import specifier for SDK types. Defaults to '@setu-ts/sdk'.

readonly
optional
apiTypeName: string

Name of the exported interface describing the generated client, and the factory's return type. Defaults to 'Api'.

The factory needs a written-out return type or JSR rejects the generated file as a slow type, which blocks .d.ts generation — so a consumer could not publish a package containing it. Naming the interface is also the only way a consumer can name the client's type at all.

Configure it when a component schema in the document is already called Api: every emitted type name is claimed from one registry, so the clash throws rather than emitting two declarations of one name.

Usage

import { type OpenApiCodegenOptions } from "sdk/src/index.ts";