SuperAPI AI 工具集

avoid-anecdotal-types

编程与开发

查看项目

更新于 10-16 00:05

技能介绍

用途:在从示例数据创建类型、类型与所有情况不符、或 API 响应多变时使用,避免基于孤例推断类型。

主要能力:强调类型应基于规范而非样本,识别“示例驱动类型”的常见问题;给出获取权威类型的途径,包括官方文档/规范、TypeScript 或 JSON Schema 定义、由 OpenAPI/GraphQL 生成的类型;并提倡用运行时校验(如 zod)保证数据与类型一致。

使用方式:不要从一个 API 响应或一条数据库记录直接写 interface。优先查官方规范;若无文档,则检查多个示例(新用户、老用户、已删除、管理员、不同地区等)与错误、空结果等边界情况,构建含可选字段和联合类型的防御性类型。对 JSON.parse 得到的数据使用运行时 schema 校验,例如用 UserSchema.parse(data) 在运行时捕获不匹配。

适用场景:为外部 API、数据库、第三方服务建型,或调试“不可能”的类型错误。

限制:资料未提供具体安装命令、版本要求或收费信息;所述方法与示例来自“Effective TypeScript”第 42 条,实际实现需结合项目中的规范与工具。