Skip to content

Query Kit compatibility

The supported list response is:

ts
type PaginatedResponse<T> = {
  items: T[];
  meta: { itemCount: number; pageCount: number };
};
ParameterShape emitted by this package
page, perPagePagination numbers
whereJSON string of a nested Query Kit condition
orderByJSON string of nested ascending/descending rules
fieldsCompact field grammar, for example id,title,author{name}
includeNested qs payload, for example include[author]=true

where and orderBy are serialized as JSON strings and encoded with qs. The fields parameter uses the existing Query Kit selection grammar. The table starts with id (unless staticFields changes that set), adds visible columns, and adds nested column.fields below each column ID.

The list response must use items, not data, and provide meta.itemCount and meta.pageCount. Authentication, workspace host replacement, endpoint maps, and backend authorization remain in the consumer application.

Released under the MIT License.