Skip to content
On this page

KirbyQueryRequest

Importable from #nuxt-kql.

ts
import type { KirbyQueryRequest } from '#nuxt-kql'

Types

INFO

Types are re-exported from the kirby-fest package.

ts
type KirbyQueryModel<T extends string = never> =
  | 'collection'
  | 'file'
  | 'kirby'
  | 'page'
  | 'site'
  | 'user'
  | T

type KirbyQuery<T extends string = never> =
  | KirbyQueryModel<T>
  | `${KirbyQueryModel<T>}.${string}`
  | `${KirbyQueryModel<T>}(${string})`

interface KirbyQueryRequest {
  query: KirbyQuery
  select?: Record<string, any> | string[]
  pagination?: {
    /** @default 100 */
    limit?: number
    page?: number
  }
}

Released under the MIT License.