Skip to content

Response Types ​

INFO

These types belong to the kirby-types package – import them from there, as described in Using Types. The page shows kirby-types 2, for Kirby 6 – Using Types names what differs in v1.

KirbyApiResponse ​

The envelope of a Kirby API response: the HTTP status code, status as 'ok' or 'error', and an optional result payload.

Examples

ts
// Success response
const success: KirbyApiResponse<{ title: string }> = {
  code: 200,
  status: 'ok',
  result: {
    title: 'Homepage'
  }
}

// Error response
const error: KirbyApiResponse = {
  code: 404,
  status: 'error'
  // result is undefined for errors
}

Type Declarations

ts
export interface KirbyApiResponse<T = any> {
  code: number
  status: 'ok' | 'error'
  result?: T
  message?: string
  key?: string | null
  details?: Record<string, any> | any[]
  exception?: string
  file?: string
  line?: number
  route?: string | null
}

KirbyQueryResponse ​

The response to a KQL query: a KirbyApiResponse whose result carries pagination when Pagination is true.

See Typed Query Results for the guide.

Examples

ts
import type { KirbyQueryResponse } from 'kirby-types'

// Define the expected response structure
export interface KirbySite {
  title: string
  children: {
    id: string
    title: string
    isListed: boolean
  }[]
}

// `data` will be of type `KirbyQueryResponse<KirbySite>`
const { data } = await useKql<KirbyQueryResponse<KirbySite>>({
  query: 'site',
  select: {
    title: true,
    children: {
      query: 'site.children',
      select: {
        id: true,
        title: true,
        isListed: true
      }
    }
  }
})

Type Declarations

ts
export type KirbyQueryResponse<
  T = any,
  Pagination extends boolean = false,
> = KirbyApiResponse<
  Pagination extends true
    ? {
        data: T
        pagination: {
          page: number
          pages: number
          offset: number
          limit: number
          total: number
        }
      }
    : T
>

Released under the MIT License.