# type-fest：高级 TypeScript 实用程序类型 type-fest 为生产 TypeScript 应用程序提供了 180 多个编译时实用程序类型，运行时开销为零。当内置 TypeScript 实用程序不足以执行严格的类型操作、深度转换或复杂的类型级编程时，请使用它。 ## 何时使用此技能 **激活：** * API响应/请求类型转换（snake_case ↔camelCase） * 深度配置合并和部分更新 * 具有只读保证的不可变状态管理 * JSON序列化类型安全（日期→字符串等） * 通过严格检查删除/选择对象属性 * 类型安全的路径访问和属性选择 * 异步函数返回类型提取 * 条件类型操作 **跳过：** * 运行时验证（使用 zod/yup/io-ts - type-fest 仅在编译时） * 内置 `Partial`、`Pick`、`Omit` 涵盖的简单情况 * 运行时类型防护（通过运行时检查补充类型盛宴） ## 安装 npm install 类型盛宴精细导入以实现最佳的 tree-shaking：从 'type-fest' 导入类型 {Except、Merge、PartialDeep、Jsonify}； ## 基本实用程序 ### `Except` \- 严格的属性删除 **在以下情况下使用：** 通过编译时验证从对象中删除密钥。 **相对于“Omit”的优点：** 捕获拼写错误 - 需要删除的键才能实际存在。从 'type-fest' 导入类型 {Except}；界面用户{ id：号码；电子邮件：字符串；密码：字符串；作用：字符串； } // 删除公共API的敏感字段类型 PublicUser = except<用户, '密码'>; // 结果: { id: 数字;电子邮件：字符串；作用：字符串 } // 捕获拼写错误类型 Bad = except<用户, '密码'>; // ✗ 错误：“密码”不存在 // 严格模式防止重新添加省略的 props 类型 StrictPublic = except<用户, '密码', {requireExactProps: true}>; ### `Merge` \- 类型安全的对象合并 **在以下情况下使用：** 组合类型，其中第二种类型的属性覆盖第一种类型。从 'type-fest' 导入类型 {Merge}；接口基础配置{ 主机：字符串；端口：号码；超时：数量； } 接口 ProdOverrides { 端口：3306； // 文字类型 ssl：布尔值；池大小：数量； } 类型 ProdConfig = Merge; // 结果：{ 主机：字符串；端口：3306；超时：数量； ssl：布尔值；池大小：数字 } ### `PartialDeep` \- 递归可选属性 **在以下情况下使用：** 深层配置对象或嵌套部分更新。从 'type-fest' 导入类型 {PartialDeep}；界面应用程序设置{ 主题：{ 颜色：{ 主要：字符串；次要：字符串； }; 字体大小：数字； }; 特点：{ 自动保存：布尔值； }; } // 用户可以覆盖任何嵌套属性函数 updateSettings(更新: PartialDeep) { // 允许updates.theme?.colors?.primary } // 有效调用 updateSettings({主题: {颜色: {primary: '#ff0000'}}}); updateSettings({功能: {自动保存: false}}); updateSettings({主题: {fontSize: 16}}); ### `Jsonify` \- JSON 序列化类型 **在以下情况下使用：** 键入经过 JSON 序列化的 API 响应/请求。 **它的作用：** * `日期` → `字符串` * `Map`, `Set` → `{}` * 函数，“未定义”→ 已删除 * 递归地转换嵌套类型从 'type-fest' 导入类型 {Jsonify}；界面活动{ 用户ID：号码；时间戳：日期；元数据：Map<字符串，字符串>；处理程序：() => void; } 类型 ApiActivity = Jsonify; // 结果: { userId: number;时间戳：字符串；元数据：{} } //（处理程序和映射已删除，日期 → 字符串）异步函数 fetchActivity(id: string): Promise { const 响应 = 等待 fetch(`/api/activity/${id}`); const json: ApiActivity =等待response.json(); // 重建正确的类型返回{ 用户Id：json.userId， timestamp: new Date(json.timestamp), // 字符串 → 日期元数据：new Map(), 处理程序：() => console.log('已加载') }; } ### `ReadonlyDeep` \- 深度不变性 **在以下情况下使用：** 在状态管理、配置对象中强制执行不变性。从 'type-fest' 导入类型 {ReadonlyDeep}；接口状态{ 用户：数组<{ id：号码；个人资料：{名称：字符串}； }>; } 类型 ImmutableState = ReadonlyDeep; const state: ImmutableState = {users: [{id: 1, profile: {name: 'John'}}]}; // 所有修改尝试都会导致错误状态.users.push(...); // ✗ 错误 state.users[0].profile.name = '简'; // ✗ 错误 ### `CamelCase` \- 大小写转换 **在以下情况下使用：** 将 API/数据库命名转换为 JavaScript 约定。从 'type-fest' 导入类型 {CamelCase}；接口 DbUser { '用户 ID'：数字； '电子邮件地址'：字符串； 'created_at'：字符串； } 类型应用程序用户 = { [DbUser 键中的 K 为 CamelCase]：DbUser[K] }; // 结果: { userId: number;电子邮件地址：字符串；创建于：字符串} // 还可用：SnakeCase、KebabCase、PascalCase ### `LiteralUnion` \- 自动完成保留联合 **在以下情况下使用：** 创建可扩展字符串枚举以保留 IDE 自动完成功能。 **问题已解决：** `'红色' | '蓝色' | string` 失去了“red”和“blue”的自动完成功能。从 'type-fest' 导入类型 {LiteralUnion}； // 没有 LiteralUnion - 没有自动完成类型 BadColor = '红色' | '蓝色' | '绿色' |细绳; // 使用 LiteralUnion - IDE 自动完成已知值类型 Color = LiteralUnion<'red' | '蓝色' | '绿色'，字符串>; 函数设置主题（颜色：颜色）{ // IDE 建议“红色”、“蓝色”、“绿色” // 但也接受 '#FF5733'、'custom-color' 等。 } ### `AsyncReturnType` \- 展开 Promise 类型 **在以下情况下使用：** 输入异步函数结果而无需手动解包 Promise。从 'type-fest' 导入类型 {AsyncReturnType}；异步函数 fetchUser(id: number) { const res = wait fetch(`/api/users/${id}`); const 数据 = 等待 res.json(); 返回{ 身份证号，名称：数据.名称，电子邮件：数据.电子邮件，角色：data.roles as string[] }; } 类型 User = AsyncReturnType; // 结果: { id: 数字;姓名：任意；电子邮件：任何；角色：字符串[]} // 在回调中使用函数 processUsers(用户: User[]) { users.forEach(u => console.log(u.name)); } ### `RequireAtLeastOne` \- 条件必需的道具 **在以下情况下使用：** 强制“至少必须存在其中一个字段”。从 'type-fest' 导入类型 {RequireAtLeastOne}；接口搜索参数{ 查询？：字符串；用户ID？：号码；电子邮件？：字符串；标签？：字符串[]； } 类型 ValidSearch = RequireAtLeastOne; 函数搜索（参数：ValidSearch）{ // 至少保证以下之一：query、userId 或 email } 搜索（{查询：'测试'}）； // ✓ 搜索({userId: 123, 标签: ['tag']}); // ✓ 搜索（{标签：['标签']}）； // ✗ 错误：需要查询、用户 ID 或电子邮件 ### `ConditionalPick` \- 按类型选择 **使用时间：**提取与特定类型匹配的属性。从 'type-fest' 导入类型 {ConditionalPick}；接口端点{ 路径：字符串；方法：'获取'| '邮政'; 超时：数量；重试次数：次数；处理程序：（请求：任意）=> Promise<任意>；验证：（数据：任意）=> 布尔值； } // 只提取函数类型 EndpointFns = ConditionalPick<端点，函数>; // 结果：{ 处理程序：...;验证：... } // 只提取数字类型 EndpointNums = ConditionalPick<端点，数字>; // 结果：{ 超时：数字；重试次数：次数 } ### `Paths` \- 类型安全的属性路径 **使用时间：**构建类型安全的获取/设置实用程序，例如 lodash。从 'type-fest' 导入类型 {Paths}；接口配置{ 数据库：{ 主机：字符串；凭证：{ 用户：字符串；密码：字符串； }; }; api: {端点: 字符串}; } 类型 ConfigPath = Paths<配置>; // 联合: '数据库' | '数据库.主机' | '数据库.凭据' | // 'database.credentials.user' | '数据库.凭据.密码' | // 'api' | 'api.端点' 函数 get

(config: Config, 路径: P): 任意 { return path.split('.').reduce((obj: any, key) => obj?.[key], config); } get(config, 'database.credentials.user'); // ✓ 自动完成 get(config, '无效的路径'); // ✗ 类型错误 ### `Simplify` \- 展平交叉点类型 **在以下情况下使用：** 改进组合类型的 IDE 提示和类型可分配性。从 'type-fest' 导入类型 {Simplify}；类型位置 = {x: 数字; y：数字}；类型大小 = {宽度：数字；高度：数字}；类型样式= {颜色：字符串；不透明度：数字}； // 不使用 Simplify - IDE 显示：位置、大小和样式复杂类型=位置&大小&样式； // 使用 Simplify - IDE 显示平面对象 type Simple = Simplify<位置、大小和样式>; // 结果: { x: 数字; y：数字；宽度：数量；高度：数字；颜色: 字符串;不透明度：数字 } ## 常见模式 ### 具有类型转换的 API 客户端从 'type-fest' 导入类型 {Except、Jsonify、CamelCase、AsyncReturnType、ReadonlyDeep}； // 外部 API (snake_case) 接口 ApiUser { 用户 ID：号码；电子邮件地址：字符串；创建于：字符串； } // 内部应用程序（驼峰命名法）类型应用程序用户 = { [K in keyof ApiUser as CamelCase]: ApiUser[K] }; // 公共用户（无敏感数据）类型 PublicUser = except; // 不可变状态类型 UserState = ReadonlyDeep; 类用户服务{ async getUser(id: number): Promise { const res = wait fetch(`/api/users/${id}`); const 数据：Jsonify = wait res.json(); 返回{ 用户Id：data.user_id，电子邮件地址：data.email_address，创建时间：data.created_at }; } } 类型 User = AsyncReturnType; ### 配置管理从 'type-fest' 导入类型 {PartialDeep、Merge、Simplify}；接口基础配置{ 数据库：{主机：字符串；端口：号码}； api: {超时: 数字}; } 接口 EnvOverrides { 数据库：{端口：3306}； api: {重试次数: 次数}; } // 合并并展平类型 FinalConfig = Simplify>; 函数加载配置（默认值：基本配置，覆盖： PartialDeep ): 最终配置 { // 深度合并逻辑返回 {...defaults, ...overrides} 作为 FinalConfig； } ### 类型安全的构建器从 'type-fest' 导入类型 {RequireAtLeastOne, Merge}；接口基本请求{ 超时？：数量；标题？：记录<字符串，字符串>； } 接口必填字段 { 网址：字符串； } 类型 HttpRequest = RequireAtLeastOne< 合并, '网址' >; 类 HttpClient { 请求（配置：HttpRequest）{ // config.url 保证存在 fetch(config.url, { 方法：'获取'，标头：config.headers }); } } ## 构图策略组合实用程序以实现强大的类型转换：从 'type-fest' 导入类型 {Merge、Simplify、PartialDeep、Except}； // 基础 + 覆盖 + 展平类型 CleanMerge = Simplify>; // 去除敏感+深度部分类型 SafePartial = PartialDeep>; // 链接多个操作类型 ComplexType = 简化< 合并< 合并<基本类型，覆盖类型>，最终类型 > >; ## 重要问题 ### 1\.运行时与编译时 **关键：** type-fest 类型不会在运行时验证。 // 不要假设运行时安全函数过程（数据：Jsonify）{ const date = new Date(data.timestamp); // 如果数据格式错误可能会失败 } // 添加运行时验证函数过程（数据：Jsonify）{ if (typeof data.timestamp !== 'string') { throw new Error('无效的时间戳'); } const date = new Date(data.timestamp); } ### 2\.深度类型嵌套限制避免过多的 `PartialDeep`/`ReadonlyDeep` 嵌套（最多 3-4 层）： // 不要类型 Bad = PartialDeep>; // 做类型 Good = PartialDeep; ### 3\.仅导入您需要的内容 Tree-shaking 对于粒度导入效果最好： // 做从 'type-fest' 导入类型 {Except, Merge}； // 不要从 'type-fest' 导入类型 * 作为 TypeFest； ### 4\. `LiteralUnion` 范围不要与已经很窄的类型一起使用： // 不要类型 Bad = LiteralUnion<'active', 'active' | '不活动'>; // 做类型 Good = LiteralUnion<'active' | '不活动'，字符串>; ## 快速参考需要| type-fest 实用程序 |另类 ---|---|--- 删除键（严格）| `除了 ` | `省略`（宽松）合并对象 | `合并` | “T 与 U”（交叉点）深部偏| `PartialDeep` | `部分`（浅）深度只读 | `ReadonlyDeep` | `只读`（浅） JSON 安全类型 | `Jsonify` |手动改造大小写转换| `驼峰命名法` |手动测绘可扩展枚举 | `LiteralUnion` | `T | U`（无自动完成）兑现承诺 | `AsyncReturnType` |手动提取需要一些钥匙 | `RequireAtLeastOne` |自定义条件类型按类型选择| `ConditionalPick` |自定义映射类型输入路径 | `路径` |字符串文字展平类型 | `简化` |交叉口类型 ## 附加实用程序 **还提供（总共 180+）：** * `RequireExactlyOne` \- 只需要一个键 * `SetRequired`, `SetOptional` \- 修改单个属性 * `SnakeCase`, `KebabCase`, `PascalCase` \- 其他大小写转换 * `IsEqual` \- 类型相等检查 * `Get` \- 类型安全的属性访问 * `Opaque` \- 品牌类型 * `PromiseValue` \- 提取 Promise 值 * 加上 170 多个更专业的实用程序浏览完整列表： ## 资源 * **GitHub：** * **文档：** * **完整类型列表：** 浏览 `/source` 目录 * **示例：** 检查测试文件的使用模式 * **法学硕士指南：**

类型盛宴

包含技能