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

1.7 KiB

name: search description: Use when implementing or debugging code that uses @suaveplan/search: Full-text and fuzzy search primitives with in-memory BM25 engine, trigram fuzzy matching, faceted search, and pagination support.

@suaveplan/search

Full-text and fuzzy search primitives with in-memory BM25 engine, trigram fuzzy matching, faceted search, and pagination support.

When to use this skill

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

Quick reference

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

Dependencies

Workspace dependencies: @suaveplan/error, @suaveplan/pagination, @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/platform/search/README.md — overview, install, quick-start, module index
  2. packages/platform/search/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/platform/search/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/pagination
  • @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.