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 生态和开发者习惯的持续关注,使得类型系统能够更好地服务于实际开发需求。
登录后查看全文
热门项目推荐
相关项目推荐
atomcodeClaude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get StartedRust0153- DDeepSeek-V4-ProDeepSeek-V4-Pro(总参数 1.6 万亿,激活 49B)面向复杂推理和高级编程任务,在代码竞赛、数学推理、Agent 工作流等场景表现优异,性能接近国际前沿闭源模型。Python00
LongCat-Video-Avatar-1.5最新开源LongCat-Video-Avatar 1.5 版本,这是一款经过升级的开源框架,专注于音频驱动人物视频生成的极致实证优化与生产级就绪能力。该版本在 LongCat-Video 基础模型之上构建,可生成高度稳定的商用级虚拟人视频,支持音频-文本转视频(AT2V)、音频-文本-图像转视频(ATI2V)以及视频续播等原生任务,并能无缝兼容单流与多流音频输入。00
auto-devAutoDev 是一个 AI 驱动的辅助编程插件。AutoDev 支持一键生成测试、代码、提交信息等,还能够与您的需求管理系统(例如Jira、Trello、Github Issue 等)直接对接。 在IDE 中,您只需简单点击,AutoDev 会根据您的需求自动为您生成代码。Kotlin03
Intern-S2-PreviewIntern-S2-Preview,这是一款高效的350亿参数科学多模态基础模型。除了常规的参数与数据规模扩展外,Intern-S2-Preview探索了任务扩展:通过提升科学任务的难度、多样性与覆盖范围,进一步释放模型能力。Python00
skillhubopenJiuwen 生态的 Skill 托管与分发开源方案,支持自建与可选 ClawHub 兼容。Python0112
热门内容推荐
最新内容推荐
项目优选
收起
暂无描述
Dockerfile
733
4.75 K
deepin linux kernel
C
31
16
Ascend Extension for PyTorch
Python
651
797
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed.
Get Started
Rust
1.25 K
153
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.1 K
611
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
1.01 K
1.01 K
华为昇腾面向大规模分布式训练的多模态大模型套件,支撑多模态生成、多模态理解。
Python
147
237
昇腾LLM分布式训练框架
Python
168
200
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
434
395
暂无简介
Dart
986
253