SuperAPI AI 工具集

api-client

编程与开发

查看项目

更新于 10-16 00:32

技能介绍

该技能用于在微软 TypeScript 仓库的 ./packages/typescript 目录下处理 API 客户端相关工作,提供编码约定说明。

用途:指导 API 客户端的改造与维护。资料仅给出两条约定,未说明具体 API、命令或运行方式,相关细节暂未提供。

主要约定一:代码注释。即使用户提示可参考 Strada(旧的 TypeScript 代码库)实现,注释也不应提及本代码库是其他项目的移植。注释应自洽,描述当前代码库中的代码,不得写“Mirrors TypeScript's 'foo' function”或“……like the classic API's 'Bar' type”之类表述。

主要约定二:避免不必要的展开与 exactOptionalPropertyTypes。不要写 ...(options ? { snapshot: options.snapshot } : {}) 这类代码,所有可选属性都应能容忍 undefined。若 --exactOptionalPropertyTypes 迫使写出这种代码,应修正有问题的类型,而不是改写成 if (options) foo.snapshot = options.snapshot 来绕过。规则是:输入位置使用的对象类型,可选属性应始终定义为 prop?: T | undefined。

限制:资料未提供安装、调用方式、依赖、平台或效果等事实,均暂未提供。