TypeScript 7 reference · Utility Types

TypeScript Exclude<UnionType, ExcludedMembers> Utility Type

Remove members from a union type. Exclude<'a' | 'b' | 'c', 'a'> is 'b' | 'c'.

TypeScript 7 Since 2.8

Create a free account to save this page, take notes and track your progress. Sign in

Syntax

Exclude<UnionType, ExcludedMembers>

Parameters

Parameter	Description
`UnionType`	The union to filter.
`ExcludedMembers`	Members to remove.

Return value

The remaining union members.

Examples

Remove members from a unionTry it yourself

type Event = "click" | "scroll" | "keydown" | "keyup";
type MouseEvent = Exclude<Event, "keydown" | "keyup">;
const e: MouseEvent = "scroll";
// @ts-expect-error: keydown was excluded
const k: MouseEvent = "keydown";
console.log(e);

Output

scroll

Remove nullTry it yourself

type Primitive = string | number | boolean | null;
type NotNull = Exclude<Primitive, null>;
const values: NotNull[] = ["a", 1, true];
console.log(values);