kirby-types
TypeScript icon, indicating that this package has built-in type declarations

0.7.1 • Public • Published

kirby-types

NPM version

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

Setup

# pnpm
pnpm add -D kirby-types

# npm
npm i -D kirby-types

# yarn
yarn add -D kirby-types

Basic Usage

import type { KirbyQuery } from "kirby-types";

// Strictly typed query
const query: KirbyQuery = 'page.children.filterBy("featured", true)';

// Invalid queries will throw a type error
let invalidQuery: KirbyQuery;
invalidQuery = "unknown"; // Not a valid model
invalidQuery = 'site("'; // Empty parentheses
invalidQuery = 'site("value"'; // Missing closing parenthesis

API

By clicking on a type name, you will be redirected to the corresponding TypeScript definition file.

API

Query

Blocks

Layout

KQL

License

MIT License © 2022-PRESENT Johann Schopplich

Package Sidebar

Install

npm i kirby-types

Weekly Downloads

449

Version

0.7.1

License

MIT

Unpacked Size

8.48 kB

Total Files

9

Last publish

Collaborators

  • johannschopplich