@querry-kit/nuxt GitHub

API Reference

@querry-kit/nuxt exposes framework-neutral runtime primitives. Applications provide their own Axios instance, authentication, routing, storage, endpoint map, and visual components.

import { createApiClient, useModuleApi } from '@querry-kit/nuxt/api';
import { useTable } from '@querry-kit/nuxt/table';
import { useAutocomplete } from '@querry-kit/nuxt/autocomplete';
import type { EndpointMap, TableColumnInput } from '@querry-kit/nuxt/types';

Main Areas

AreaUse for
API clientCreating a Query Kit-aware Axios client with current token, timezone, source, and tenant-host resolution.
Resource APITyped query, get, findById, count, create, update, and delete methods for one endpoint.
useTableRemote pagination, fields, filtering, sorting, persistence, URL-page syncing, and stale-request protection.
useAutocompleteCombining selected resources with search results without duplicate identities.
Utilities and typesQuery serialization, filter/order conversion, endpoint contracts, and headless UI metadata.

Public Imports

ImportContents
@querry-kit/nuxtRe-exports all public runtime functions.
@querry-kit/nuxt/apicreateApiClient, useModuleApi, and client types.
@querry-kit/nuxt/tableuseTable; its options type is exported through ./types.
@querry-kit/nuxt/autocompleteuseAutocomplete and UseAutocompleteOptions.
@querry-kit/nuxt/typesEndpoint, response, table, filter/sort field, persistence, and route-ref contracts.
@querry-kit/nuxt/utilsSerialization and Query Kit state helpers.

Reference groups

Each reference group is kept on one page, so related types and functions can be read together.

  • API: Axios client and endpoint methods
  • Autocomplete: autocomplete options and composable
  • Table: table options and composable
  • Types: endpoint, response, table, persistence, and route contracts
  • Utils: serialization and Query Kit state helpers

Before wiring a composable, confirm the application backend implements the controller contract.