首页
/ Kysely 项目中的枚举类型支持改进:从可变数组到只读数组

Kysely 项目中的枚举类型支持改进:从可变数组到只读数组

2025-05-19 23:34:30作者:段琳惟

在 TypeScript 开发中,枚举类型的定义和使用是一个常见需求。Kysely 作为一个现代化的 SQL 查询构建器,提供了 createType().asEnum() 方法来支持 PostgreSQL 中的枚举类型。然而,当前实现存在一个限制:它只接受可变字符串数组,而无法直接处理 TypeScript 中常见的只读数组定义方式。

背景:TypeScript 中的枚举模式

在 TypeScript 生态中,开发者经常使用以下模式来定义枚举类型:

export const ProcessType = ['develop', 'test', 'qa', 'release'] as const;
export type ProcessType = (typeof ProcessType)[number];

这种模式有几个显著优点:

  1. 提供了运行时值检查的能力
  2. 通过 as const 断言确保数组元素的字面量类型
  3. 通过类型推导自动生成联合类型

然而,由于 as const 会将数组标记为只读,这就与 Kysely 当前 asEnum() 方法要求的可变字符串数组参数产生了类型冲突。

技术实现分析

Kysely 的 asEnum() 方法目前定义为接受 string[] 类型参数。从实现角度来看,这个方法实际上并不会修改传入的数组,因此理论上完全可以接受 readonly string[] 类型的参数。

TypeScript 的类型系统中,readonly string[]string[] 的超类型,这意味着所有 string[] 都可以赋值给 readonly string[],但反过来则不行,除非显式地移除只读修饰符。

改进方案

Kysely 团队已经确认这是一个合理的改进方向,并计划在后续版本中更新 asEnum() 方法的类型定义,使其能够接受只读数组。这一改动将:

  1. 保持向后兼容,现有的可变数组代码仍然有效
  2. 支持更符合 TypeScript 习惯的枚举定义方式
  3. 不需要修改运行时行为,仅是类型定义的调整

开发者影响

对于使用 Kysely 的开发者来说,这一改进意味着:

  • 可以直接使用 as const 定义的数组来创建枚举类型
  • 不再需要为了类型兼容性而移除 as const 断言或进行类型转换
  • 代码将更加类型安全,减少潜在的错误

最佳实践建议

即使在这一改进发布后,开发者在使用枚举类型时仍应注意:

  1. 优先使用 as const 定义枚举值数组,以获得更好的类型推断
  2. 考虑将枚举定义集中管理,便于维护和重用
  3. 对于大型项目,可以考虑将枚举类型与数据库类型定义分离

这一改进体现了 Kysely 项目对 TypeScript 生态和开发者习惯的持续关注,使得类型系统能够更好地服务于实际开发需求。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
197
2.17 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
208
285
pytorchpytorch
Ascend Extension for PyTorch
Python
59
94
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
973
574
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
549
81
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
1.2 K
133