TypeScript 4.1 快要发布了,老爷子 Anders Hejlsberg[1] 加入了一项重大更新,「字符串模板类型」 的支持。昨天看到这个更新的我特别兴奋,曾几何时,只要一遇到字符串拼接相关的类型,TypeScript 就束手无策了,比如:
Vuex
中加了namespace
以后,dispatch
一个mutation type
会带上前缀dispatch('cart/add')
。lodash
的get
方法,可以对一个对象进行get(obj, 'a.b.c')
这样的读取。
现在 4.1 加入的这个新功能让这一切都拥有了可能。
基础语法
它的语法和 es 里的字符串模板很相似,所以上手成本也很低,先看几个例子:
type EventName<T extends string> = `${T}Changed`; type T0 = EventName<'foo'>; // 'fooChanged' type T1 = EventName<'foo' | 'bar' | 'baz'>; // 'fooChanged' | 'barChanged' | 'bazChanged'
type Concat<S1 extends string, S2 extends string> = `${S1}${S2}`; type T2 = Concat<'Hello', 'World'>; // 'HelloWorld'
字符串模板中的联合类型会被展开后排列组合:
type T3 = `${'top' | 'bottom'}-${'left' | 'right'}`; // 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right'
新增关键字
为了这个功能,老爷子在 TS 中新增了 uppercase
, lowercase
, capitalize
, uncapitalize
这些关键字,用于对模板粒度字符串变量进行处理。
type Cases<T extends string> = `${uppercase T} ${lowercase T} ${capitalize T} ${uncapitalize T}`; type T11 = Cases<'bar'>; // 'BAR bar Bar bar'
其实很简单,就是提供了几个处理方法:大写、小写,首字母大写,首字母小写。
配合 infer
特别强大的一点是,模板字符串可以通过 infer
关键字,实现类似于正则匹配提取的功能:
type MatchPair<S extends string> = S extends `[${infer A},${infer B}]` ? [A, B] : unknown; type T20 = MatchPair<'[1,2]'>; // ['1', '2'] type T21 = MatchPair<'[foo,bar]'>; // ['foo', 'bar']
通过 ,
分割左右两边,再在左右两边分别用一个 infer
泛型接受推断值 [${infer A},${infer B}]
,就可以轻松的重新组合 ,
两边的字符串。
配合 ...
拓展运算符和 infer
递归,甚至可以实现 Join
功能:
type Join<T extends (string | number | boolean | bigint)[], D extends string> = T extends [] ? '' : T extends [unknown] ? `${T[0]}` : T extends [unknown, ...infer U] ? `${T[0]}${D}${Join<U, D>}` : string; type T30 = Join<[1, 2, 3, 4], '.'>; // '1.2.3.4' type T31 = Join<['foo', 'bar', 'baz'], '-'>; // 'foo-bar-baz'
实战运用
实现 Vuex namespace 推断:
``type VuexOptions<M, N> = {
namespace?: N,
mutations: M,
}
type Action<M, N> = N extends string ? ${N}/${keyof M & string}
: keyof M
type Store<M, N> = {
dispatch(action: Action<M, N>): void
}
declare function Vuex<M, N>(options: VuexOptions<M, N>): Store<M, N>
const store = Vuex({
namespace: "cart" as const,
mutations: {
add() { },
remove() { }
}
})
store.dispatch("cart/add")
store.dispatch("cart/remove")
``
前往 Playground[2] 尝试一下~
实现 lodash get 函数:
``type PropType<T, Path extends string> =
string extends Path ? unknown :
Path extends keyof T ? T[Path] :
Path extends ${infer K}.${infer R}
? K extends keyof T ? PropType<T[K], R> : unknown :
unknown;
declare function get<T, P extends string>(obj: T, path: P): PropType<T, P>;
const obj = { a: { b: {c: 42, d: 'hello' }}};
const value = get(obj, "a.b.c")
``
前往 Playground[3] 尝试一下~
总结
TypeScript 4.1 带来的这个新功能让 TS 支持更多字符串相关的拼接场景,其实是特别实用的,希望各位看了以后都能有所收获~
参考资料
[1]
Anders Hejlsberg: https://github.com/ahejlsberg
[2]
[3]
本文分享自微信公众号 - 胡哥有话说(hugeyouhuashuo)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。