Skip to content

Reference ​

The exported symbols, their type definitions, and the options each one takes. For how the pieces fit together, start with the guide.

Methods ​

MethodWhat it does
createClientCreates a client from default fetch options. Every APIful client starts here.
createOpenAPIClientCreates a client typed from the generated types of one service, without the extension chain.
defineApifulConfigDeclares the services the generate command reads.
Type GeneratorGenerates the types the generate command writes, for tools that write them themselves.

Types ​

TypeWhat it describes
ApiClientThe client itself: its default options and the with method that extends it.
HandlerExtensionBuilderA function that takes the client and returns its call signature.
MethodsExtensionBuilderA 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.