Files
suaveplan/packages/devtools/tooling/install-agent-skills/assets/skills/pagination/SKILL.md
2026-05-27 23:29:53 +01:00

2.0 KiB

name: pagination description: Use when implementing or debugging code that uses @suaveplan/pagination: Universal pagination primitives: cursor, offset, keyset strategies with adapters, iterators, and type-safe request/response shapes.

@suaveplan/pagination

Universal pagination primitives for cursor-based, offset-based, and keyset-based (seek) pagination strategies. The package covers the full pagination surface: request normalisation, response envelope construction, opaque cursor and page-token encoding, async iterators that drain pages automatically, a pluggable adapter interface for any data source, and optional OpenTelemetry instrumentation. All three strategies share the same error hierarchy and Zod schemas so they compose cleanly in multi-strategy APIs.

When to use this skill

  • Implementing or debugging code that imports @suaveplan/pagination.
  • The task touches: see package README.
  • You need API guidance for this package's exports.

Quick reference

import { /* see API Reference below */ } from "@suaveplan/pagination";

Dependencies

Workspace dependencies: @suaveplan/error, @suaveplan/types

Where to read more

This skill is intentionally short. The package's own documentation is the authoritative source — read these in order:

  1. packages/foundation/pagination/README.md — overview, install, quick-start, module index
  2. packages/foundation/pagination/src/**/*.md — co-located docs per implementation file (Purpose, Features, Basic + Advanced examples, full API reference, Implementation notes — all packages ship ≥200 words per module)
  3. packages/foundation/pagination/package.json exports map — every subpath you can import from

When the user asks an API question, read the relevant co-located .md first; do not answer from training-data memory.

See also

  • @suaveplan/error
  • @suaveplan/types

This SKILL.md is auto-generated by suaveplan-skills/scripts/generate-skills.ts from the package's README. Do not edit by hand — re-run the generator after the README changes.