nuxt-kql
Version:
Kirby's Query Language API for Nuxt
17 lines (16 loc) • 884 B
TypeScript
import type { KirbyQueryRequest, KirbyQueryResponse } from 'kirby-types';
import type { NitroFetchOptions } from 'nitropack';
export type KirbyFetchOptions = Omit<NitroFetchOptions<string>, 'baseURL'> & {
/**
* Language code to fetch data for in multi-language Kirby setups.
*/
language?: string;
};
export type KqlFetchOptions = Pick<NitroFetchOptions<string>, 'onRequest' | 'onRequestError' | 'onResponse' | 'onResponseError' | 'headers' | 'retry' | 'retryDelay' | 'retryStatusCodes' | 'timeout'> & {
/**
* Language code to fetch data for in multi-language Kirby setups.
*/
language?: string;
};
export declare function $kirby<T = any>(path: string, opts?: KirbyFetchOptions): Promise<T>;
export declare function $kql<T extends KirbyQueryResponse<any, boolean> = KirbyQueryResponse>(query: KirbyQueryRequest, opts?: KqlFetchOptions): Promise<T>;