kirby-fest

A collection of TypeScript types to work with Kirby, mainly in the context of the Kirby Query Language.

Setup

# pnpm
pnpm add -D kirby-fest

# npm
npm i -D kirby-fest

Basic Usage

import type { KirbyQuery } from "type-fest";

// Strictly typed query for the Kirby Query Language
const query: KirbyQuery = 'kirby.page("about")';

API

Click the type names for complete docs.

Query

KirbyQueryModel - Matches any supported KirbyQL model.
KirbyQuery - Matches a KirbyQL query.

Blocks

KirbyBlockType - Matches any Kirby block type.
KirbyBlock - Matches a Kirby block.

Layout

KirbyLayout - Matches a Kirby layout.
KirbyLayoutColumn - Matches any supported layout width.

KQL

KirbyQuerySchema - Matches a KQL query schema.
KirbyQueryRequest - Matches any KQL request.
KirbyQueryResponse - Matches any KQL response.

License

MIT License © 2022 Johann Schopplich