0

0

如何在 TypeScript 中创建一个类型来检索对象的所有键

DDD

DDD

发布时间:2024-09-16 14:21:01

|

947人浏览过

|

来源于dev.to

转载

如何在 typescript 中创建一个类型来检索对象的所有键

typescript 有一个名为 keyof 的功能,可用于获取对象的键。然而,keyof 运算符仅适用于对象的第一层,当我们想要获取深层的所有键时,事情会变得有点复杂。在这篇文章中,我们将讨论如何实现一个可以深层获取所有键的类型。

问题概述

为了理解我们要解决的问题,让我们从一个例子开始。考虑以下对象:

const obj = {
  a: {
    b: 1,
    c: {
      d: 2,
      e: 3
    }
  },
  f: {
    g: 4
  }
}

如果我们想要获取这个对象的所有键,包括嵌套对象中的键,我们需要一个可以递归遍历该对象并返回所有键的类型。这可能是一项具有挑战性的任务,特别是对于具有多层嵌套的复杂对象。

可能的解决方案

解决此问题的一种方法是使用递归类型定义。 typescript 允许我们使用交集类型定义递归类型。交集类型是表示具有交集中所有类型的所有属性的值的类型。

我们可以定义一个递归类型来表示具有一组键的对象,其中每个键要么是一个原始值,要么是另一个也具有一组键的对象。下面是我们如何定义这种类型:

type deepkeys<t> = t extends object
  ? {
      [k in keyof t]-?: k extends string | number
        ? `${k}` | `${k}.${deepkeys<t[k]>}`
        : never;
    }[keyof t]
  : never;

这个类型定义可能看起来有点复杂,所以让我们把它分解成更小的部分。

类型 deepkeys<t> 是一个条件类型,用于检查输入类型 t 是否为对象。如果 t 是一个对象,我们使用映射类型创建一个与 t 具有相同键的新对象,但值是嵌套对象的键,表示为字符串。如果 t 不是对象,我们返回一个空字符串。

映射类型使用 keyof 运算符来获取对象的键,然后我们使用条件语句来检查每个键是否是字符串或数字。如果键是字符串或数字,我们将其与点和嵌套对象的键连接起来,使用 deepkeys<t[k]> 递归获得。如果密钥不是字符串或数字,我们将返回 never,这意味着密钥无效。

Gambo
Gambo

世界上首个游戏氛围编程智能体

下载

使用类型

现在我们已经定义了 deepkeys 类型,我们可以使用它来获取任何具有嵌套对象的对象的键。这是我们如何使用它的示例:

const obj = {
  a: {
    b: 1,
    c: {
      d: 2,
      e: 3,
    },
  },
  f: {
    g: 4,
  },
  h: undefined,
};

type DeepKeys<T> = T extends object
  ? {
      [K in keyof T]-?: K extends string | number
        ? `${K}` | `${K}.${DeepKeys<T[K]>}`
        : never;
    }[keyof T]
  : never;

function getAllKeys<T extends object>(
  obj: T,
  prefix: string = '',
): DeepKeys<T>[] {
  return Object.entries(obj).reduce((result: string[], [key, value]) => {
    const newPrefix = prefix ? `${prefix}.${key}` : key;

    return result.concat([
      newPrefix,
      ...(typeof value === 'object' && value !== null
        ? getAllKeys(value, newPrefix)
        : []),
    ]);
  }, []) as DeepKeys<T>[];
}

const keys = getAllKeys(obj);
console.log(keys); // ["a" | "f" | "h" | "a.b" | "a.c" | "a.c.d" | "a.c.e" | "f.g"]

在此示例中,我们定义了一个名为 getallkeys 的函数,该函数将一个对象作为参数并返回该对象中所有键的数组。我们使用 object.keys 方法获取对象的键,然后将结果转换为 deepkeys 类型,以确保我们获取所有键,包括嵌套对象中的键。

限制

虽然 deepkeys 类型在许多情况下都很有用,但它确实有一些限制。一个限制是它仅适用于深度有限的对象。如果我们有一个无限深度的对象,例如包含对自身的引用的对象,类型定义将导致堆栈溢出错误。

另一个限制是,对于具有多层嵌套的对象,结果类型可能非常复杂,这可能会使其难以使用。在某些情况下,可能需要使用更简单的类型定义或不同的方法来获取对象的键。

结论

在本文中,我们讨论了如何实现一个可以获取对象中所有键(包括嵌套对象中的键)的类型。我们使用递归类型定义来定义 deepkeys 类型,它允许我们递归遍历对象并返回所有键。我们还提供了如何使用 deepkeys 类型获取对象的密钥的示例。

虽然 deepkeys 类型有一些限制,但它可以成为处理具有嵌套对象的对象的有用工具。


如果您发现这有帮助,请考虑 订阅我的时事通讯 以获取更多有关 web 开发的有用文章和工具。感谢您的阅读!

相关文章

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

49

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

199

2026.02.25

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

90

2026.03.13

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1570

2023.10.24

Go语言中的运算符有哪些
Go语言中的运算符有哪些

Go语言中的运算符有:1、加法运算符;2、减法运算符;3、乘法运算符;4、除法运算符;5、取余运算符;6、比较运算符;7、位运算符;8、按位与运算符;9、按位或运算符;10、按位异或运算符等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

241

2024.02.23

php三元运算符用法
php三元运算符用法

本专题整合了php三元运算符相关教程,阅读专题下面的文章了解更多详细内容。

170

2025.10.17

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

761

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

221

2023.09.04

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

69

2026.03.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号