TypeScript中的互斥类型实现方法示例

 更新时间:2022年04月12日 09:26:42   作者:神奇的程序员  
用了一年时间的TypeScript了,下面这篇文章主要给大家介绍了关于TypeScript中互斥类型实现的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下

前言

有这样一个对象,它有两个属性:name与title,在赋值的时候这两个属性只有一个能出现,例如:name出现的时候title就不能出现,title出现的时候name就不能出现。

此时,你会怎么用TypeScript来定义这个类型?本文将带大家实现一个互斥类型来解决这个问题,欢迎各位感兴趣的开发者阅读本文。

前置知识

在实现之前,我们需要先来了解几个基础的知识。

对象中多属性同类型的定义

有一个对象它包含5个可选属性a、b、c、d、e,他们的类型都为string,大多数人的定义方式应该如下所示:

type obj = {
  a?:string;
  b?:string;
  c?:string;
  d?:string;
  e?:string;
}

那么,有没有更好的方式呢😼,答案是有的,请看我的表演:

type obj = { [P in "a" | "b" | "c" | "d" | "e"]?: string };

never类型

在TypeScript中它有一个特殊的类型never,它是所有类型的子类型,无法再进行细分,也就意味着除了其本身没有类型可以再分配给它。

我们举个例子来解释下上述话语,如下所示:

  • 我们定义了一个变量amazing,给其赋予了never类型。
  • 我们分别给它赋了不同类型的值,全部编译失败,因为它无法再进行细分了。
let amazing: never;
amazing = 12;// 报错:amazing是never类型不能分配给number类型
amazing = true;// 报错:amazing是never类型不能分配给boolean类型
amazing = "真神奇";// 报错:amazing是never类型不能分配给string类型
amazing = {};// 报错:amazing是never类型不能分配给{}类型
amazing = [];// 报错:amazing是never类型不能分配给[]类型

剔除联合类型中的属性

有一组联合类型"a" | "b" | "c" | "d",我们想剔除属性b和c,在TS中提供了一个名为Exclude的函数,它可以用来做这件事,接受两个参数:

  • UnionType 联合类型
  • ExcludedMembers 需要进行剔除的属性

使用方法如下所示:

type P = Exclude<"a" | "b" | "c" | "d", "b" | "c"> // "a" | "d"

将对象中的所有属性转为联合类型

有一个对象它包含2个可选属性name、title,我们想把它转为联合类型name | title ,在TS中提供了一个名为keyof的函数,他可以用来处理这个问题,使用方法如下所示:

type A =  { [P in "name" | "title"]?: string };

type UnionType = keyof A; // "name" | "title"

实现互斥类型

有了前置知识作为铺垫,接下来我们就可以将其利用起来,定义一个互斥类型出来,解决文章开头所讲述的问题。

接下来,我们来梳理下实现思路:

  • 实现一个排除类型,用于从A对象类型中剔除B对象类型中的属性,并将排除后的属性类型设为never,得到一个新对象类型。
  • 基于排除类型实现互斥类型,将A、B对象类型代入排除类型中,彼此将其排除,用或运算符将二者结果连接。

聪明的开发者可能已经猜到原理了,没错,就是部分属性设为never。🤓

实现代码

接下来,我们来看下代码的实现,如下所示:

// 定义排除类型:将U从T中剔除, keyof 会取出T与U的所有键, 限定P的取值范围为T中的所有键, 并将其类型设为never
type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };

// 定义互斥类型,T或U只有一个能出现(互相剔除时,被剔除方必须存在)
type XOR<T, U> = (Without<T, U> & U) | (Without<U, T> & T);

注意:为了类型的可复用性,我们使用了泛型,对此不熟悉的开发者请移步:TypeScript中文网——泛型

测试用例

我们将文章开头所说的问题代入上述实现代码中,看一下它能否将其解决😌,如下所示:

// A类型
type A = {
  name: string;
};

// B类型
type B = {
  title: string;
};

// A和B两种类型只有一个能出现
type AOrB = XOR<A, B>;

// 传值测试
const AOrB1: AOrB = { name: "姓名" }; // 编译通过
const AOrB2: AOrB = { title: "标题" }; // 编译通过
const AOrB3: AOrB = { title: "标题", name: "姓名" }; // 报错: Type '{ title: string; name: string; }' is not assignable to type 'AOrB'.
const AOrB4: AOrB = { name: "姓名", otherKey: "" }; // 报错:Type '{ name: string; otherKey: string; }' is not assignable to type 'AOrB'.

当两个属性同时出现时,编辑器直接就抛出了类型错误(我们把排除后的所有属性的类型设为了never,因此当你给其赋任何值时它都会报类型错误),如下图所示:

用例拆解

有一部分开发者可能对上述测试用例比较懵,把它们拆开都认识,因为前置知识里都讲了,但是写到一起就不认识了😹,没关系,那我就把它们都拆解出来吧,代码如下所示:

type AOB = ({ name?: never } & {
      title: string;
    }) | ({ title?: never } & {
      name: string;
    });

// 传值测试
const a: AOB = { name: "姓名" }; // 编译通过
const b: AOB = { title: "标题" }; // 编译通过
const c: AOB = { title: "标题", name: "姓名" }; // 报错
const d: AOB = { title: "标题", otherKey: "" }; // 报错

看到这里,可能还有一部分开发者没有理解,那就动起手来在编辑器里敲一敲,如果还没理解的话,就先把这篇文章收藏,日后有时间了,在拿出来学一学。

写在最后

至此,文章就分享完毕了。

到此这篇关于TypeScript中互斥类型实现的文章就介绍到这了,更多相关TypeScript互斥类型内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • javascript fullscreen全屏实现代码

    javascript fullscreen全屏实现代码

    用了实现打开一个满屏的代码
    2009-04-04
  • canvas实现钟表效果

    canvas实现钟表效果

    本文主要分享了canvas实现钟表效果的示例代码。具有很好的参考价值,下面跟着小编一起来看下吧
    2017-02-02
  • 使用webpack3.0配置webpack-dev-server教程

    使用webpack3.0配置webpack-dev-server教程

    这篇文章主要介绍了使用webpack3.0配置webpack-dev-server教程,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-05-05
  • JS+Canvas实现满屏爱心和文字动画的制作

    JS+Canvas实现满屏爱心和文字动画的制作

    Canvas 适合绘制大数据量图形元素的图表(如热力图、地理坐标系或平行坐标系上的大规模线图或散点图等),也适合实现某些视觉特效。本文就来利用Canvas实现满屏爱心和文字动画的制作,感兴趣的可以了解一下
    2022-11-11
  • JS脚本根据手机浏览器类型跳转WAP手机网站(两种方式)

    JS脚本根据手机浏览器类型跳转WAP手机网站(两种方式)

    随着移动互联网的不断普及,企业的网络宣传不仅只局限在PC端,还要在移动端发展。我们在自己的网站做了WAP手机完整之后,如果有用户通过手机访问我们的企业顶级域名网站,就要判断跳转到专为的WAP网站,下面小编给大家整理有关手机浏览器跳转WAP手机网站的相关内容
    2015-08-08
  • JavaScript数值转换的三种方式总结

    JavaScript数值转换的三种方式总结

    JavaScript数值转换一般有三种方式,Number(param)函数、parseInt(param)、parseIFloat(param),下面为大家详细介绍,需要的朋友可以参考下
    2014-07-07
  • element-table表格中插入颜色块显示数据状态的示例代码

    element-table表格中插入颜色块显示数据状态的示例代码

    这篇文章主要介绍了element-table表格中插入颜色块显示数据状态,代码部分分为dom部分和data部分及css部分,本文结合示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2023-12-12
  • Flash图片上传组件 swfupload使用指南

    Flash图片上传组件 swfupload使用指南

    这篇文章主要介绍了Flash图片上传组件 swfupload使用方法及示例,swfupload的使用范围十分的广泛,功能也很强大,今天我们就先来简单的通过范例来学习下。
    2015-03-03
  • 微信小程序实现滑动侧边栏

    微信小程序实现滑动侧边栏

    这篇文章主要为大家详细介绍了微信小程序实现滑动侧边栏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-07-07
  • Aptana调试javascript图解教程

    Aptana调试javascript图解教程

    用Aptana软件来调试javascript的方法,一般情况下大家都使用firefox浏览器+firebug来调试的。
    2009-11-11

最新评论