API Reference
Four composables for fetching from Kirby, two server-side counterparts, and a set of types for the queries and responses that travel between. All composables are auto-imported by Nuxt and available globally in your project.
| Page | What it covers |
|---|---|
| Module Configuration | The options of the kirby key in your nuxt.config.ts. |
useKql | Reactive KQL queries with caching, for content queries that follow relationships and filter. |
$kql | Direct KQL calls for programmatic use. |
useKirbyData | Reactive data fetching from the REST API with caching, for plain requests, file handling and endpoints of your own. |
$kirby | Direct REST API calls for programmatic use. |
| Server Imports | $kql and $kirby in server code, where they reach Kirby without the proxy. |
| Using Types | The types for Kirby data and queries, and where each one applies. |
| Query Types | The shape of a query and the models it may address. |
| Request Types | What you hand to useKql and $kql. |
| Response Types | What comes back, including pagination. |