Request 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.
KirbyQueryRequest
A KQL query: the main query, optional field selections, and pagination settings.
Examples
ts
// Basic query
const basicQuery = {
query: 'site',
select: {
title: true,
description: true
}
} satisfies KirbyQueryRequest
// With nested selections
const nestedQuery = {
query: 'page("blog").children',
select: {
title: true,
date: 'page.date.toDate("Y-m-d")',
author: {
query: 'page.author.toUser',
select: ['name', 'email']
}
}
} satisfies KirbyQueryRequest
// With pagination
const paginatedQuery = {
query: 'page("blog").children.published',
select: {
title: true,
excerpt: 'page.text.excerpt(200)'
},
pagination: {
limit: 10,
page: 1
}
} satisfies KirbyQueryRequest
// Array selection
const arrayQuery = {
query: 'page("about")',
select: ['title', 'text', 'images']
} satisfies KirbyQueryRequestType Declarations
ts
export interface KirbyQuerySchema {
/** Defaults to `site`. */
query?: KirbyQuery
select?:
| string
| string[]
| Record<string, string | boolean | KirbyQueryNestedRequest>
}
export interface KirbyQueryRequest extends KirbyQuerySchema {
queries?:
| Record<string, KirbyQuery | KirbyQueryRequest>
| (KirbyQuery | KirbyQueryRequest)[]
pagination?: {
/** Defaults to the `pagination.limit` option, or `20`. */
limit?: number
page?: number
}
}