Codex 用对象参数和 TSDoc 维护 Querylight TS 公共 API
EnglishCodex 安装步骤
- 从固定 GitHub 提交复制 `.codex/skills/api-style-guardrails/` 完整目录到项目 `.agents/skills/api-style-guardrails/`。
- 选择 `$api-style-guardrails` 并指出 `packages/querylight/src` 下的目标接口。
中文摘要
给新公开接口选择清楚的对象参数名称，并让类型、说明、示例和测试同步。
SKILL.md 中文导读
可复现示例
在练习分支给本地文本搜索添加新辅助函数，输入为字段名、搜索词和权重，比较三个位置参数与一个命名参数对象。工作步骤
- 先读现有导出、参数命名和兼容要求。
- 在改动表面统一文档和调用示例，运行仓库测试与构建。
验收方法
选定的对象包含可辨认的字段，公开类型有简短 TSDoc，示例与测试使用相同签名。
GitHub 原文 · 更新日期
适用环境
Codex、Querylight TS 固定工作副本及该仓库 npm 工具链。
常见问题
只有一个标量参数时也必须包装吗？
源文允许在直接标量确实更清楚时保留它。