Skip to content
On this page

How It Works

tl;dr

With a internal /api/__kql__ server route proxying your query request.

Detailed Answer

When passing a KQL query to either useKql or $kql as a parameter, the corresponsing composable will initiate a POST request to the Nuxt server route /api/__kql__ defined by this module. The KQL query will be encoded in the request body.

The internal server route then fetches the actual data for a given query from the Kirby instance and passes the response back to the template/client. Thus, no KQL requests to the Kirby instance are initiated on the client-side.

This proxy behaviour has the benefit of omitting CORS issues, since data is sent from server to server.

During server-side rendering, calling useKql or $kql to fetch the /api/__kql__ API route will directly call the relevant function (emulating the request), saving an additional API call. Thus, only the fetch request from Nuxt to Kirby would be performed.

INFO

Query responses are cached (with a key calculated by hashing the query). Subsequent calls will return cached responses, saving duplicated requests.

Released under the MIT License.