ts-tooltype

Common TypeScript generic tool types at work

主要整理了工作中常用的 TypeScript 类型体操工具类型

Install

npm i -D ts-tooltype

Number 相关

NumberToStr

将数字转为字符串

type Test = NumberToStr<999>; // "999"

GenerateNumArr

从 0 开始自增 1，得到指定长度的数组，由于 TS 递归限制最大只能传 999

type Test = GenerateNumArr<3>; // [0, 1, 2]

RangeNumber

生成指定整数范围的联合类型

type Test = RangeNumber<0, 5>; // 0 | 1 | 2 | 3 | 4 | 5

Object 相关

DeepMerge

深合并对象类型

type Test = DeepMerge<{ a: { a: 1; b: 3 } }, { a: { a: 3; c: 3 } }>; // {a: { a: 3; b: 3; c: 3; } }

SelectTypeKey

获取对象中指定类型的 key 的联合类型

type Test = SelectTypeKey<{ a: 1; b: true; c: 3 }, number>; // 'a' | 'c'

PickKeyType

返回指定“类型”的 key 组成的对象

type Test = PickKeyType<{ a: 1; b: true; c: 3 }, number>; // { a: 1; c: 3; }

OmitKeyType

剔除指定“类型”的 key 后组成的对象

type Test = OmitKeyType<{ a: 1; b: true; c: 3 }, number>; // { b: true; }

PickPartial

指定 K 为可选，K 可传联合类型表示指定多个 key 可选

type Test = PickPartial<{ a: 1; b: 2; c: 3 }, "a" | "b">; //{a?: 1, b?: 2, c: 3}

String 相关

StringToNumber

将字符串转为数字，只能转换 0 - 999 的整数

type Test = StringToNumber<"999">; // 999

Union 相关（联合类型）

UnionToIntersection

联合类型转为交叉类型，利用的是 extends 分发的特性结合在函数参数发生的逆变且被提取为同一类型参数名后，则该类型参数会变为交叉类型的特性

type Test = UnionToIntersection<{ a: 1 } | { b: 2 }>; // {a: 1} & {b: 2}

UnionToTuple

联合类型转为元组类型

type Test = UnionToTuple<"2" | "1" | "3">; // ["2", "1", "3"]

IsUnion

判断一个类型是不是联合类型，利用元组包裹联合类型阻止被分发去判断

type Test = IsUnion<1 | 2 | 3>; // true