Exclude, Extract i NonNullable w TypeScript

Exclude<T, U> usuwa człony z typu unii, Extract<T, U> zostawia tylko pasujące człony, a NonNullable<T> usuwa null i undefined. Wszystkie trzy filtrują unie; nie ruszają właściwości obiektów.

type Status = "draft" | "review" | "published" | "archived";

type Visible = Exclude<Status, "draft" | "archived">; // "review" | "published"
type Editable = Extract<Status, "draft" | "review">;   // "draft" | "review"

const shown: Visible[] = ["review", "published"];
const editing: Editable = "draft";
console.log(shown, editing); // [ 'review', 'published' ] draft

// @ts-expect-error: Type '"draft"' is not assignable to type 'Visible'.
const bad: Visible = "draft";

Jak każdy typ narzędziowy, istnieją one tylko w czasie kompilacji. Ostatnią linię odrzuca kompilator; uruchamiany JavaScript nie ma pojęcia, czym jest Visible.

Exclude, Extract i NonNullable w skrócie

Kluczowe jest sformułowanie „da się przypisać do U”. U nie musi być listą dokładnych członów; może to być szerszy typ, do którego pasuje kilka członów:

type Input = string | number | boolean | (() => void) | null;

type Primitive = Exclude<Input, (() => void) | null>; // string | number | boolean
type Callable = Extract<Input, (...args: never[]) => unknown>; // () => void
type Present = NonNullable<Input>; // string | number | boolean | (() => void)

const values: Primitive[] = ["a", 1, true];
const run: Callable = () => console.log("called");
const p: Present = 42;

run();
console.log(values, p); // [ 'a', 1, true ] 42

Wybieranie członów unii po kształcie

W unii dyskryminowanej Extract z częściowym kształtem wyciąga warianty, które ten kształt mają. To typowy sposób na nazwanie jednego wariantu unii pochodzącej z cudzego kodu:

type AppEvent =
    | { type: "click"; x: number; y: number }
    | { type: "key"; key: string }
    | { type: "scroll"; delta: number };

type ClickEvent = Extract<AppEvent, { type: "click" }>;
type NonClickEvent = Exclude<AppEvent, { type: "click" }>;

function handleClick(e: ClickEvent): string {
    return `click at ${e.x},${e.y}`; // x and y are available
}

function describe(e: NonClickEvent): string {
    return e.type === "key" ? `key ${e.key}` : `scroll ${e.delta}`;
}

console.log(handleClick({ type: "click", x: 10, y: 20 })); // click at 10,20
console.log(describe({ type: "key", key: "Enter" }));      // key Enter

Kształt { type: "click" } jest nadtypem tylko wariantu kliknięcia, więc Extract zostawia właśnie ten wariant. Kształt pasujący do kilku wariantów (na przykład { x: number }, gdyby miały go dwa) zostawia wszystkie z nich.

NonNullable

NonNullable<T> to typowa wersja sprawdzenia !== null && !== undefined. Pojawia się, gdy wyprowadzasz typ z czegoś opcjonalnego:

type User = { name: string; manager?: { name: string } | null };

type Manager = NonNullable<User["manager"]>; // { name: string }

function managerName(m: Manager): string {
    return m.name; // no null check needed
}

const u: User = { name: "Ada", manager: { name: "Grace" } };
if (u.manager) {
    console.log(managerName(u.manager)); // Grace
}

// Filtering null and undefined out of an array, with a matching type:
const raw: Array<string | null | undefined> = ["a", null, "b", undefined];
const clean = raw.filter((s): s is NonNullable<typeof s> => s != null);
console.log(clean); // [ 'a', 'b' ]

User["manager"] to { name: string } | null | undefined (znak ? dodaje undefined), a NonNullable usuwa oba. Od TypeScriptu 5.5 kompilator sam wnioskuje taki predykat, więc raw.filter((s) => s != null) ma już typ string[]; jawne s is NonNullable<typeof s> pokazuje intencję i działa w starszych wersjach. Definicja to type NonNullable<T> = T & {}: pusty typ obiektowy {} przyjmuje każdą wartość oprócz null i undefined, więc przecięcie z nim usuwa dokładnie te dwie.

Jak są zbudowane

Exclude i Extract to jednolinijkowe typy warunkowe w bibliotece standardowej:

type Exclude<T, U> = T extends U ? never : T;
type Extract<T, U> = T extends U ? T : never;

Gdy T jest unią, typ warunkowy jest stosowany do każdego członu osobno (rozdziela się, czyli jest dystrybutywny), a człony never znikają z wyniku. Dlatego Exclude<"a" | "b", "a"> staje się ("a" extends "a" ? never : "a") | ("b" extends "a" ? never : "b"), czyli never | "b", czyli "b". Dystrybucję szczegółowo opisuje strona o typach warunkowych.

Exclude a Omit, Extract a Pick

Nazwy łatwo pomylić, bo obie pary coś „usuwają” albo „zostawiają”. Różnica polega na tym, na czym działają:

Użycie Exclude na typie obiektowym to częsta pomyłka, która nie zgłasza żadnego błędu:

type Account = { id: number; email: string; password: string };

type Wrong = Exclude<Account, "password">; // still Account: not a union of "password"
type Right = Omit<Account, "password">;    // { id: number; email: string }

const safe: Right = { id: 1, email: "ada@example.com" };
const oops: Wrong = { id: 1, email: "ada@example.com", password: "hunter2" };
console.log(Object.keys(safe), Object.keys(oops));
// [ 'id', 'email' ] [ 'id', 'email', 'password' ]

Account nie da się przypisać do "password", więc Exclude zostawia go w całości. Sam Omit jest zbudowany z Exclude zastosowanego do kluczy: Omit<T, K> to Pick<T, Exclude<keyof T, K>>. Więcej znajdziesz na stronie o Omit.

Ściślejszy Exclude

Drugi parametr Exclude przyjmuje dowolny typ, więc literówka niczego nie usuwa i nie zgłasza błędu. Dodanie ograniczenia sprawia, że kompilator sprawdza, czy to, co wykluczasz, naprawdę jest w unii:

// This does not compile: "drafft" is not a Status.
type Status = "draft" | "published" | "archived";

type StrictExclude<T, U extends T> = Exclude<T, U>;

type Loose = Exclude<Status, "drafft">;        // silently Status, unchanged
type Strict = StrictExclude<Status, "drafft">; // error

const s: Strict = "published";
console.log(s);

index.ts(7,37): error TS2344: Type '"drafft"' does not satisfy the constraint 'Status'.

Po poprawieniu pisowni kod się kompiluje, a Strict jest równy "published" | "archived". Ta sama sztuczka działa dla Extract i dla ścisłego Omit (K extends keyof T).