首页
/ 在ts-pattern中实现自定义类型守卫的模式匹配

在ts-pattern中实现自定义类型守卫的模式匹配

2025-05-17 22:57:21作者:申梦珏Efrain

ts-pattern是一个强大的TypeScript模式匹配库,它允许开发者以声明式的方式处理复杂的条件逻辑。在实际开发中,我们经常需要处理特定格式的数据类型,如UUID、Email地址等。本文将介绍如何在ts-pattern中优雅地处理这些自定义类型。

自定义类型守卫的需求

在TypeScript中,类型守卫是一种特殊的函数,它能够缩小变量的类型范围。例如,我们可能有以下类型守卫函数:

function isUUID(value: string): value is UUID {
  return /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i.test(value);
}

function isEmail(value: string): value is Email {
  return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(value);
}

这些函数不仅能在运行时验证数据格式,还能在编译时帮助TypeScript进行类型推断。

ts-pattern的解决方案

ts-pattern提供了P.when模式,专门用于处理这种自定义类型守卫的场景。P.when接受一个类型守卫函数作为参数,当匹配时,它会自动将类型缩小到守卫函数定义的类型。

基本用法

import { P } from 'ts-pattern';

const pattern = {
  id: P.when(isUUID),
  email: P.when(isEmail)
};

type User = P.infer<typeof pattern>;
// 推断结果为: { id: UUID; email: Email }

实际应用示例

假设我们有一个用户注册系统,需要验证输入数据的格式:

function validateUser(input: unknown) {
  return P.match(input)
    .with(
      {
        id: P.when(isUUID),
        email: P.when(isEmail),
        age: P.number
      },
      (user) => {
        // 这里user的类型已经被推断为
        // { id: UUID; email: Email; age: number }
        return { valid: true, user };
      }
    )
    .otherwise(() => ({ valid: false }));
}

高级用法

P.when不仅可以用于简单的类型守卫,还可以结合其他模式一起使用:

P.match(value)
  .with(
    {
      type: 'user',
      data: P.when(isUserData)
    },
    ({ data }) => {
      // 处理已验证的user数据
    }
  )
  .with(
    {
      type: 'product',
      data: P.when(isProductData)
    },
    ({ data }) => {
      // 处理已验证的product数据
    }
  );

类型安全的好处

使用P.when的最大优势在于它保持了ts-pattern的类型安全性。TypeScript能够正确推断出匹配后的类型,避免了任何类型断言的需要,同时确保了编译时的类型检查。

总结

ts-pattern的P.when模式为处理自定义类型提供了优雅的解决方案。通过结合TypeScript的类型守卫功能,开发者可以构建既安全又富有表现力的模式匹配逻辑。这种方法特别适合需要验证特定数据格式的场景,如UUID、Email、URL等,使得代码更加健壮且易于维护。

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