Kysely 项目中的枚举类型支持改进:从可变数组到只读数组
2025-05-19 04:37:03作者:段琳惟
在 TypeScript 开发中,枚举类型的定义和使用是一个常见需求。Kysely 作为一个现代化的 SQL 查询构建器,提供了 createType().asEnum() 方法来支持 PostgreSQL 中的枚举类型。然而,当前实现存在一个限制:它只接受可变字符串数组,而无法直接处理 TypeScript 中常见的只读数组定义方式。
背景:TypeScript 中的枚举模式
在 TypeScript 生态中,开发者经常使用以下模式来定义枚举类型:
export const ProcessType = ['develop', 'test', 'qa', 'release'] as const;
export type ProcessType = (typeof ProcessType)[number];
这种模式有几个显著优点:
- 提供了运行时值检查的能力
- 通过
as const断言确保数组元素的字面量类型 - 通过类型推导自动生成联合类型
然而,由于 as const 会将数组标记为只读,这就与 Kysely 当前 asEnum() 方法要求的可变字符串数组参数产生了类型冲突。
技术实现分析
Kysely 的 asEnum() 方法目前定义为接受 string[] 类型参数。从实现角度来看,这个方法实际上并不会修改传入的数组,因此理论上完全可以接受 readonly string[] 类型的参数。
TypeScript 的类型系统中,readonly string[] 是 string[] 的超类型,这意味着所有 string[] 都可以赋值给 readonly string[],但反过来则不行,除非显式地移除只读修饰符。
改进方案
Kysely 团队已经确认这是一个合理的改进方向,并计划在后续版本中更新 asEnum() 方法的类型定义,使其能够接受只读数组。这一改动将:
- 保持向后兼容,现有的可变数组代码仍然有效
- 支持更符合 TypeScript 习惯的枚举定义方式
- 不需要修改运行时行为,仅是类型定义的调整
开发者影响
对于使用 Kysely 的开发者来说,这一改进意味着:
- 可以直接使用
as const定义的数组来创建枚举类型 - 不再需要为了类型兼容性而移除
as const断言或进行类型转换 - 代码将更加类型安全,减少潜在的错误
最佳实践建议
即使在这一改进发布后,开发者在使用枚举类型时仍应注意:
- 优先使用
as const定义枚举值数组,以获得更好的类型推断 - 考虑将枚举定义集中管理,便于维护和重用
- 对于大型项目,可以考虑将枚举类型与数据库类型定义分离
这一改进体现了 Kysely 项目对 TypeScript 生态和开发者习惯的持续关注,使得类型系统能够更好地服务于实际开发需求。
登录后查看全文
热门项目推荐
相关项目推荐
GLM-5智谱 AI 正式发布 GLM-5,旨在应对复杂系统工程和长时域智能体任务。Jinja00
GLM-5.1GLM-5.1是智谱迄今最智能的旗舰模型,也是目前全球最强的开源模型。GLM-5.1大大提高了代码能力,在完成长程任务方面提升尤为显著。和此前分钟级交互的模型不同,它能够在一次任务中独立、持续工作超过8小时,期间自主规划、执行、自我进化,最终交付完整的工程级成果。Jinja00
MiniMax-M2.7MiniMax-M2.7 是我们首个深度参与自身进化过程的模型。M2.7 具备构建复杂智能体应用框架的能力,能够借助智能体团队、复杂技能以及动态工具搜索,完成高度精细的生产力任务。Python00- QQwen3.5-397B-A17BQwen3.5 实现了重大飞跃,整合了多模态学习、架构效率、强化学习规模以及全球可访问性等方面的突破性进展,旨在为开发者和企业赋予前所未有的能力与效率。Jinja00
HY-Embodied-0.5这是一套专为现实世界具身智能打造的基础模型。该系列模型采用创新的混合Transformer(Mixture-of-Transformers, MoT) 架构,通过潜在令牌实现模态特异性计算,显著提升了细粒度感知能力。Jinja00
LongCat-AudioDiT-1BLongCat-AudioDiT 是一款基于扩散模型的文本转语音(TTS)模型,代表了当前该领域的最高水平(SOTA),它直接在波形潜空间中进行操作。00
项目优选
收起
deepin linux kernel
C
28
15
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
660
4.26 K
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.54 K
894
Ascend Extension for PyTorch
Python
505
610
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
392
289
暂无简介
Dart
909
219
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
69
21
昇腾LLM分布式训练框架
Python
142
168
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
940
867
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
1.33 K
108