Codex Querylight TS Public API Style with Named Options and TSDoc
Design public TypeScript signatures with explicit parameter objects where helpful, keeping exported types, examples, and tests aligned.
中文Install in Codex
Codex, the pinned Querylight TS checkout, and its npm toolchain.
- Copy the pinned `.codex/skills/api-style-guardrails/` directory into `.agents/skills/api-style-guardrails/` in the project.
- Select `$api-style-guardrails` for the targeted interface under `packages/querylight/src`.
Example task
Add a mock text-search helper with field, search text, and weight inputs. Compare a named options object with three positional arguments.What to check
The chosen signature has descriptive keys and concise TSDoc, and the example matches the tested API.
Original SKILL.md on GitHub · Updated
Frequently asked question
Must a single scalar always be wrapped?
A direct scalar remains appropriate when it communicates the intent more clearly.