Client

Generates typed operation functions from your OpenAPI spec that call a client module you write. You decide the transport, authentication, and error handling, and the generated code has no Fetch, axios, or Kubb runtime dependency.

Use it for signed requests, a shared client, or an existing HTTP layer. For a ready-made client, use @kubb/plugin-fetch or @kubb/plugin-axios instead.

Installation

bun add -d @kubb/plugin-client

pnpm add -D @kubb/plugin-client

npm install --save-dev @kubb/plugin-client

yarn add -D @kubb/plugin-client

Or run kubb add plugin-client to install the version the Kubb registry pins and add pluginClient() to kubb.config.ts.

Setup

• Set importPath to your client module. It is required. The module must export client and the Options and RequestResult types.
• Add @kubb/plugin-ts for the operation types.
• Add @kubb/plugin-zod when you set validator. Generation fails without it.

Options worth knowing

• importPath is written into every generated import as given, so it must resolve from the generated file. A relative path, a package name, or an alias works.
• validator: 'zod' passes request and response schemas from @kubb/plugin-zod to your client.
• throwOnErrorDefault is the throwOnError value each call passes to your client. The default is true.