Discriminated unions in Typescript

Introduction

Discriminated unions help you work with different types of data in one place safely. They let you tell which type you have by checking a special property.

When you have a variable that can hold different shapes of data, like a shape that can be a circle or a square.

When you want to write code that handles different cases clearly and safely without mistakes.

When you want TypeScript to help you catch errors by knowing exactly which type you are working with.

When you want to switch between different types and run different code for each type.

Syntax

Typescript

type Shape =
  | { kind: "circle"; radius: number }
  | { kind: "square"; size: number };

function area(shape: Shape) {
  switch (shape.kind) {
    case "circle":
      return Math.PI * shape.radius ** 2;
    case "square":
      return shape.size ** 2;
  }
}

The kind property is the discriminant that tells TypeScript which type it is.

Use a switch or if to check the discriminant and handle each case.

Examples

This defines an animal that can be a dog or a cat, distinguished by the type property.

Typescript

type Animal =
  | { type: "dog"; barkVolume: number }
  | { type: "cat"; livesLeft: number };

Here we check the type to know if the animal is a dog or cat and use the right property.

Typescript

function speak(animal: Animal) {
  if (animal.type === "dog") {
    console.log(`Bark volume: ${animal.barkVolume}`);
  } else {
    console.log(`Lives left: ${animal.livesLeft}`);
  }
}

This models a response that can be success or error, using status as the discriminant.

Typescript

type Response =
  | { status: "success"; data: string }
  | { status: "error"; message: string };

Sample Program

This program defines a Vehicle type that can be a car or a bike. The describe function uses the kind property to know which type it is and returns a description. We create a car and a bike and print their descriptions.

Typescript

type Vehicle =
  | { kind: "car"; wheels: 4; brand: string }
  | { kind: "bike"; wheels: 2; hasBell: boolean };

function describe(vehicle: Vehicle) {
  switch (vehicle.kind) {
    case "car":
      return `Car brand: ${vehicle.brand}, wheels: ${vehicle.wheels}`;
    case "bike":
      return `Bike with bell: ${vehicle.hasBell}, wheels: ${vehicle.wheels}`;
  }
}

const myCar: Vehicle = { kind: "car", wheels: 4, brand: "Toyota" };
const myBike: Vehicle = { kind: "bike", wheels: 2, hasBell: true };

console.log(describe(myCar));
console.log(describe(myBike));

Important Notes

Always use a unique string literal property as the discriminant for clear type checking.

Discriminated unions make your code safer by letting TypeScript know exactly which type you are working with.

Summary

Discriminated unions use a special property to tell types apart.

They help write clear and safe code when working with multiple types.

Use switch or if to check the discriminant and handle each case.

Practice

1.

What is the main purpose of a discriminated union in TypeScript?

easy

A. To automatically convert types at runtime

B. To create a union of unrelated primitive types

C. To enforce a single type for all variables

D. To distinguish between different object types using a common property

Solution

1. Step 1: Understand discriminated unions

   Discriminated unions use a shared property (called the discriminant) to identify which type an object belongs to.

2. Step 2: Purpose of discriminated unions

   This helps TypeScript safely narrow types in code by checking that property.

3. Final Answer:

   To distinguish between different object types using a common property -> Option D

4. Quick Check:

   Discriminated union = common property to tell types apart [OK]

Hint: Look for a shared property that identifies each type [OK]

Common Mistakes:

• Thinking discriminated unions convert types automatically
• Confusing with simple unions of primitives
• Believing they enforce one single type only

2.

Which of the following is the correct syntax to define a discriminated union type in TypeScript?

type Shape = ?

easy

A. type Shape = { kind: 'circle'; radius: number } | { kind: 'square'; side: number }

B. type Shape = { radius: number } & { side: number }

C. type Shape = { kind: string; radius?: number; side?: number }

D. type Shape = { circle: number } | { square: number }

Solution

1. Step 1: Identify discriminant property

   type Shape = { kind: 'circle'; radius: number } | { kind: 'square'; side: number } uses a common property kind with literal types ('circle' or 'square') to discriminate.

2. Step 2: Check union structure

   type Shape = { kind: 'circle'; radius: number } | { kind: 'square'; side: number } correctly uses a union of two object types distinguished by kind.

3. Final Answer:

   type Shape = { kind: 'circle'; radius: number } | { kind: 'square'; side: number } -> Option A

4. Quick Check:

   Discriminated union = union with common literal property [OK]

Hint: Look for union with a shared literal property for discrimination [OK]

Common Mistakes:

• Using intersection (&) instead of union (|)
• Missing literal type for discriminant property
• Using optional properties without discriminant

3.

What will be the output of the following TypeScript code?

type Animal =
  | { type: 'dog'; barkVolume: number }
  | { type: 'cat'; livesLeft: number };

function describe(animal: Animal) {
  switch (animal.type) {
    case 'dog':
      return `Dog barks at volume ${animal.barkVolume}`;
    case 'cat':
      return `Cat has ${animal.livesLeft} lives left`;
  }
}

console.log(describe({ type: 'cat', livesLeft: 7 }));

medium

A. Cat has 7 lives left

B. Dog barks at volume undefined

C. TypeError at runtime

D. Cat has undefined lives left

Solution

1. Step 1: Analyze the input object

   The input is { type: 'cat', livesLeft: 7 }, so the type is 'cat'.

2. Step 2: Follow the switch case

   The switch matches 'cat' case and returns `Cat has ${animal.livesLeft} lives left`, which becomes 'Cat has 7 lives left'.

3. Final Answer:

   Cat has 7 lives left -> Option A

4. Quick Check:

   Switch on discriminant returns correct string [OK]

Hint: Match the discriminant property in switch to get output [OK]

Common Mistakes:

• Confusing 'dog' and 'cat' cases
• Expecting runtime error due to union
• Ignoring the discriminant property

4.

Identify the error in this TypeScript code using discriminated unions:

type Vehicle =
  | { kind: 'car'; wheels: number }
  | { kind: 'bike'; pedals: number };

function getWheels(vehicle: Vehicle) {
  if (vehicle.kind === 'car') {
    return vehicle.wheels;
  } else {
    return vehicle.wheels;
  }
}

medium

A. Function should use switch instead of if

B. Property 'wheels' does not exist on type 'bike' object

C. Incorrect discriminant property name

D. Missing return type annotation on function

Solution

1. Step 1: Check property access in else branch

   In the else branch, the code accesses vehicle.wheels, but bike type has no wheels property.

2. Step 2: Understand TypeScript error

   This causes a type error because wheels is not defined for { kind: 'bike'; pedals: number }.

3. Final Answer:

   Property 'wheels' does not exist on type 'bike' object -> Option B

4. Quick Check:

   Accessing wrong property on union member causes error [OK]

Hint: Check property exists on all union members before access [OK]

Common Mistakes:

• Assuming all union members share same properties
• Ignoring TypeScript error messages
• Thinking switch is mandatory over if

5.

Given the following discriminated union, how can you safely add a new shape type rectangle with width and height properties and update the area function accordingly?

type Shape =
  | { kind: 'circle'; radius: number }
  | { kind: 'square'; side: number };

function area(shape: Shape): number {
  switch (shape.kind) {
    case 'circle':
      return Math.PI * shape.radius ** 2;
    case 'square':
      return shape.side ** 2;
  }
}

hard

A. Add { kind: 'rectangle'; width: number; height: number } to Shape union and replace switch with if-else

B. Add { kind: 'rectangle'; width: number; height: number } to Shape union but no change needed in area function

C. Add { kind: 'rectangle'; width: number; height: number } to Shape union and add case 'rectangle' in switch returning width * height

D. Add { kind: 'rectangle'; width: number; height: number } to Shape union and remove existing cases

Solution

1. Step 1: Extend the union type

   Add the new shape type with discriminant kind: 'rectangle' and properties width and height to the Shape union.

2. Step 2: Update the area function

   Add a new case in the switch for 'rectangle' that returns shape.width * shape.height to correctly calculate the area.

3. Final Answer:

   Add { kind: 'rectangle'; width: number; height: number } to Shape union and add case 'rectangle' in switch returning width * height -> Option C

4. Quick Check:

   Extend union and handle new case in switch [OK]

Hint: Add new type to union and handle it in switch [OK]

Common Mistakes:

• Forgetting to update the function for new type
• Removing existing cases accidentally
• Not using discriminant property in new type