typescript 定义一个必须有一个key其它随便

原创

mob64ca12e86bd4 2025-01-27 05:50:30 ©著作权

文章标签 对象类型 typescript 字段 文章分类 TypeScript 前端开发

©著作权归作者所有：来自51CTO博客作者mob64ca12e86bd4的原创作品，请联系作者获取转载授权，否则将追究法律责任

TypeScript 中定义一个必须有一个特定键的类型

TypeScript 是一种超集 JavaScript 的语言，它为 JavaScript 的开发提供了静态类型检查的能力。TypeScript 的类型系统设计得非常灵活，允许开发者根据需要定义各种类型。在这篇文章中，我们将探讨如何在 TypeScript 中定义一个对象类型，该对象必须包含一个特定的键，且允许其他任意键。

需求分析

在某些情况下，我们希望确保对象中存在某个特定键，而其他的键则可以是任意的。这种需求在处理动态数据时尤为重要，比如当我们与 REST API 进行交互时。

例如，我们可以设想一个用户对象，必须拥有 username 作为唯一的标识符，而其他字段可以是用户相关的任何信息，如 age、email 等。

TypeScript 类型定义

在 TypeScript 中，我们可以通过使用接口或者类型定义来实现这一点。这里我们将使用映射类型和条件类型的组合，确保对象中至少包含一个特定的键。

以下是我们实现这个功能的一种方法：

type AtLeastOneKey<T, K extends keyof T> = 
    Omit<T, K> & {
        [P in K]-?: T[P];
    }

解析代码

类型参数：T 表示我们要定义的类型，K 表示必须存在的键。K extends keyof T 确保 K 必须是 T 类型的一个键。
Omit：Omit<T, K> 会移除 T 中的键 K，返回去掉这个键的新对象类型。
映射类型：[P in K]-?: T[P]; 这是一个映射类型，-? 表示 K 指定的键是必需的。这样，我们就确保所定义的类型必须包含 K。

使用示例

下面是如何使用 AtLeastOneKey 类型的示例：

interface UserProfile {
    username: string;
    age?: number;
    email?: string;
}

// 定义一个新类型，要求 'username' 一定存在，但其他字段可以随意
type ValidUserProfile = AtLeastOneKey<UserProfile, 'username'>;

// 正确用法
const user1: ValidUserProfile = {
    username: 'john_doe',
    age: 30
};

const user2: ValidUserProfile = {
    username: 'jane_doe',
    email: 'jane@example.com'
};

// 错误用法：缺少 username
const user3: ValidUserProfile = {
    age: 25 // TypeScript 会报错：缺少属性 'username'
};