TypeScript 映射類型詳情
前言:
TypeScript
的官方文檔早已更新,但我能找到的中文文檔都還停留在比較老的版本。所以對(duì)其中新增以及修訂較多的一些章節(jié)進(jìn)行了翻譯整理。
本篇翻譯整理自 TypeScript Handbook 中 「Mapped Types」 章節(jié)。
本文并不嚴(yán)格按照原文翻譯,對(duì)部分內(nèi)容也做了解釋補(bǔ)充。
1.映射類型(Mapped Types)
有的時(shí)候,一個(gè)類型需要基于另外一個(gè)類型,但是你又不想拷貝一份,這個(gè)時(shí)候可以考慮使用映射類型。
映射類型建立在索引簽名的語(yǔ)法上,我們先回顧下索引簽名:
// 當(dāng)你需要提前聲明屬性的類型時(shí) type OnlyBoolsAndHorses = { [key: string]: boolean | Horse; }; const conforms: OnlyBoolsAndHorses = { del: true, rodney: false, };
而映射類型,就是使用了 PropertyKeys
聯(lián)合類型的泛型,其中 PropertyKeys
多是通過(guò) keyof
創(chuàng)建,然后循環(huán)遍歷鍵名創(chuàng)建一個(gè)類型:
type OptionsFlags<Type> = { [Property in keyof Type]: boolean; };
在這個(gè)例子中,OptionsFlags
會(huì)遍歷 Type 所有的屬性,然后設(shè)置為布爾類型。
type FeatureFlags = { darkMode: () => void; newUserProfile: () => void; }; type FeatureOptions = OptionsFlags<FeatureFlags>; // type FeatureOptions = { // darkMode: boolean; // newUserProfile: boolean; // }
2.映射修飾符(Mapping Modifiers)
在使用映射類型時(shí),有兩個(gè)額外的修飾符可能會(huì)用到,一個(gè)是 readonly,用于設(shè)置屬性只讀,一個(gè)是 ? ,用于設(shè)置屬性可選。
你可以通過(guò)前綴 - 或者 + 刪除或者添加這些修飾符,如果沒(méi)有寫(xiě)前綴,相當(dāng)于使用了 + 前綴。
// 刪除屬性中的只讀屬性 type CreateMutable<Type> = { -readonly [Property in keyof Type]: Type[Property]; }; type LockedAccount = { readonly id: string; readonly name: string; }; type UnlockedAccount = CreateMutable<LockedAccount>; // type UnlockedAccount = { // id: string; // name: string; // } // 刪除屬性中的可選屬性 type Concrete<Type> = { [Property in keyof Type]-?: Type[Property]; }; type MaybeUser = { id: string; name?: string; age?: number; }; type User = Concrete<MaybeUser>; // type User = { // id: string; // name: string; // age: number; // }
3.通過(guò) as 實(shí)現(xiàn)鍵名重新映射(Key Remapping via as)
在 TypeScript 4.1
及以后,你可以在映射類型中使用 as 語(yǔ)句實(shí)現(xiàn)鍵名重新映射:
type MappedTypeWithNewProperties<Type> = { [Properties in keyof Type as NewKeyType]: Type[Properties] }
舉個(gè)例子,你可以利用「模板字面量類型」,基于之前的屬性名創(chuàng)建一個(gè)新屬性名:
type Getters<Type> = { [Property in keyof Type as `get${Capitalize<string & Property>}`]: () => Type[Property] }; interface Person { name: string; age: number; location: string; } type LazyPerson = Getters<Person>; // type LazyPerson = { // getName: () => string; // getAge: () => number; // getLocation: () => string; // }
你也可以利用條件類型返回一個(gè) never 從而過(guò)濾掉某些屬性:
// Remove the 'kind' property type RemoveKindField<Type> = { [Property in keyof Type as Exclude<Property, "kind">]: Type[Property] }; interface Circle { kind: "circle"; radius: number; } type KindlessCircle = RemoveKindField<Circle>; // type KindlessCircle = { // radius: number; // }
你還可以遍歷任何聯(lián)合類型,不僅僅是 string | number | symbol
這種聯(lián)合類型,可以是任何類型的聯(lián)合:
type EventConfig<Events extends { kind: string }> = { [E in Events as E["kind"]]: (event: E) => void; } type SquareEvent = { kind: "square", x: number, y: number }; type CircleEvent = { kind: "circle", radius: number }; type Config = EventConfig<SquareEvent | CircleEvent> // type Config = { // square: (event: SquareEvent) => void; // circle: (event: CircleEvent) => void; // }
4.深入探索(Further Exploration)
映射類型也可以跟其他的功能搭配使用,舉個(gè)例子,這是一個(gè)使用條件類型的映射類型,會(huì)根據(jù)對(duì)象是否有 pii 屬性返回 true 或者 false :
type ExtractPII<Type> = { [Property in keyof Type]: Type[Property] extends { pii: true } ? true : false; }; type DBFields = { id: { format: "incrementing" }; name: { type: string; pii: true }; }; type ObjectsNeedingGDPRDeletion = ExtractPII<DBFields>; // type ObjectsNeedingGDPRDeletion = { // id: false; // name: true; // }
相關(guān)文章
深入分析escape()、encodeURI()、encodeURIComponent()的區(qū)別及示例
這篇文章主要介紹了escape()、encodeURI()、encodeURIComponent()的區(qū)別,需要的朋友可以參考下2014-08-08讓你的博文自動(dòng)帶上縮址的實(shí)現(xiàn)代碼,方便發(fā)到微博客上
添加以下代碼到你的博客中: (呵呵,抄襲至lulu Studio http://s8.hk/0itw)2010-12-12javascript 字符串連接的性能問(wèn)題(多瀏覽器)
今天看了javascript 高級(jí)程序設(shè)計(jì) 談到了字符串連接的性能問(wèn)題2008-11-11js實(shí)現(xiàn)base64、url和blob之間相互轉(zhuǎn)換的三種方式
Blob對(duì)象表示一個(gè)不可變、原始數(shù)據(jù)的類文件對(duì)象,Blob表示的不一定是JavaScript原生格式的數(shù)據(jù),下面這篇文章主要給大家介紹了關(guān)于js實(shí)現(xiàn)base64、url和blob之間相互轉(zhuǎn)換的三種方式,需要的朋友可以參考下2023-04-04JavaScript 語(yǔ)句之常用 for 循環(huán)詳解
這篇文章主要介紹了JavaScript 語(yǔ)句之常用 for 循環(huán),本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-03-03js 倒計(jì)時(shí)(高效率服務(wù)器時(shí)間同步)
首先說(shuō)一下,為什么要服務(wù)器時(shí)間同步, 因?yàn)榉?wù)器時(shí)間和本地電腦時(shí)間存在一定的時(shí)間差。有些對(duì)時(shí)效性要求非常高的應(yīng)用,例如時(shí)時(shí)彩開(kāi)獎(jiǎng),是不能容忍這種時(shí)間差存在的2017-09-09Iframe 自動(dòng)適應(yīng)頁(yè)面的高度示例代碼
這篇文章主要介紹了Iframe如何自動(dòng)適應(yīng)頁(yè)面的高度,需要的朋友可以參考下2014-02-02微信小程序?qū)崿F(xiàn)列表的橫向滑動(dòng)方式
這篇文章主要介紹了微信小程序?qū)崿F(xiàn)列表的橫向滑動(dòng),本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-07-07bootstrapValidator表單驗(yàn)證插件學(xué)習(xí)
這篇文章主要為大家詳細(xì)介紹了表單驗(yàn)證插件bootstrapValidator的使用方法,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2016-12-12