TypeScript 映射類型詳情

Posted on by

前言:

TypeScript 的官方文檔早已更新，但我能找到的中文文檔都還停留在比較老的版本。所以對其中新增以及修訂較多的一些章節進行瞭翻譯整理。

本篇翻譯整理自 TypeScript Handbook 中 「Mapped Types」 章節。

本文並不嚴格按照原文翻譯，對部分內容也做瞭解釋補充。

1.映射類型（Mapped Types）

有的時候，一個類型需要基於另外一個類型，但是你又不想拷貝一份，這個時候可以考慮使用映射類型。

映射類型建立在索引簽名的語法上，我們先回顧下索引簽名：

// 當你需要提前聲明屬性的類型時
type OnlyBoolsAndHorses = {
  [key: string]: boolean | Horse;
};
 
const conforms: OnlyBoolsAndHorses = {
  del: true,
  rodney: false,
};

而映射類型，就是使用瞭 PropertyKeys 聯合類型的泛型，其中 PropertyKeys 多是通過 keyof 創建，然後循環遍歷鍵名創建一個類型：

type OptionsFlags<Type> = {
  [Property in keyof Type]: boolean;
};

在這個例子中，OptionsFlags 會遍歷 Type 所有的屬性，然後設置為佈爾類型。

type FeatureFlags = {
  darkMode: () => void;
  newUserProfile: () => void;
};
 
type FeatureOptions = OptionsFlags<FeatureFlags>;
// type FeatureOptions = {
//    darkMode: boolean;
//    newUserProfile: boolean;
// }

2.映射修飾符（Mapping Modifiers）

在使用映射類型時，有兩個額外的修飾符可能會用到，一個是 readonly，用於設置屬性隻讀，一個是 ? ，用於設置屬性可選。

你可以通過前綴 – 或者 + 刪除或者添加這些修飾符，如果沒有寫前綴，相當於使用瞭 + 前綴。

// 刪除屬性中的隻讀屬性
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.通過 as 實現鍵名重新映射（Key Remapping via as）

在 TypeScript 4.1 及以後，你可以在映射類型中使用 as 語句實現鍵名重新映射：

type MappedTypeWithNewProperties<Type> = {
    [Properties in keyof Type as NewKeyType]: Type[Properties]
}

舉個例子，你可以利用「模板字面量類型」，基於之前的屬性名創建一個新屬性名：

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;
// }

你也可以利用條件類型返回一個 never 從而過濾掉某些屬性:

// 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;
// }

你還可以遍歷任何聯合類型，不僅僅是 string | number | symbol 這種聯合類型，可以是任何類型的聯合：

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）

映射類型也可以跟其他的功能搭配使用，舉個例子，這是一個使用條件類型的映射類型，會根據對象是否有 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;
// }

推薦閱讀：