Reference
The exported symbols, their type definitions, and the options each one takes. For how the pieces fit together, start with the guide.
Methods
| Method | What it does |
|---|---|
createClient | Creates a client from default fetch options. Every APIful client starts here. |
createOpenAPIClient | Creates a client typed from the generated types of one service, without the extension chain. |
defineApifulConfig | Declares the services the generate command reads. |
| Type Generator | Generates the types the generate command writes, for tools that write them themselves. |
Types
| Type | What it describes |
|---|---|
ApiClient | The client itself: its default options and the with method that extends it. |
HandlerExtensionBuilder | A function that takes the client and returns its call signature. |
MethodsExtensionBuilder | A function that takes the client and returns named methods to add to it. |
Type Helpers
OpenAPI Type Helpers name the types of one operation, or of one schema in components, from the generated types – useful when you need one in a signature of your own.