快捷導(dǎo)航

TypeScript 映射類型詳情

更新時(shí)間：2021年12月13日 17:02:01 作者：冴羽

這篇文章主要介紹了TypeScript 映射類型詳情，一個(gè)類型需要基于另外一個(gè)類型，又不想拷貝一份，這個(gè)時(shí)候可以考慮使用映射類型，映射類型建立在索引簽名的語法上，下面文章我們就從回顧下索引簽名展開TypeScript 映射類型的相關(guān)資料,需要的朋友可以參考一下

1.映射類型（Mapped Types）

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

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

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

而映射類型，就是使用了 PropertyKeys 聯(lián)合類型的泛型，其中 PropertyKeys 多是通過 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è)置屬性可選。

你可以通過前綴 - 或者 + 刪除或者添加這些修飾符，如果沒有寫前綴，相當(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.通過 as 實(shí)現(xiàn)鍵名重新映射（Key Remapping via as）

在 TypeScript 4.1 及以后，你可以在映射類型中使用 as 語句實(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 從而過濾掉某些屬性:

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

您可能感興趣的文章: