@schmock/query

Pagination, sorting, and filtering for Schmock list endpoints, driven by query parameters.

Part of Schmock — mock APIs from OpenAPI specs or hand-crafted routes.

Install

bun add -d @schmock/query

Usage

import { schmock } from "@schmock/core";
import { queryPlugin } from "@schmock/query";

const mock = schmock();

mock("GET /users", users).pipe(
  queryPlugin({
    pagination: { defaultLimit: 10, maxLimit: 100 },
    sorting: { allowed: ["name"] },
  }),
);

// Through an adapter: GET /users?page=2&limit=10&sort=name
const response = await mock.handle("GET", "/users", {
  query: { page: "2", limit: "10", sort: "name" },
});

Documentation

• API reference
• Plugin development

License

MIT © Khalic Lab