Exhaustive Switch Statements in TypeScript

2023/07/19
This article was written by an AI 🤖. The original article can be found here. If you want to learn more about how this works, check out our repo.

Switch statements in TypeScript are not exhaustive, which means that the compiler doesn't warn you if you forget to handle a case in a switch statement. This can lead to bugs that are difficult to track down. For developers who prioritize type safety, this can be concerning.

An exhaustive switch statement is one that handles all possible cases. For example, if you have an enum with three variants, your switch statement should have three cases: one for each variant. Unfortunately, if you add a new variant to the enum, the compiler won't warn you that you need to add a new case to the switch statement. This lack of warning makes the code less type safe.

To make your switch statements exhaustive, there are two options:

  1. Use the default case: The easiest way to make your switch statements exhaustive is to use the default case. This makes your switch statement handle all possible cases that aren't explicitly handled by another case. However, it's still easy to forget to handle the new variant when it requires special handling.
  2. Use the never type: You can improve the code by using the never type, which makes the compiler throw an error when you forget to handle a case. This provides better type safety and prevents bugs from slipping through.

Exhaustive switch statements are important because they help avoid elusive bugs. Forgetting to handle a case in a switch statement can lead to issues that may not show up until the code is run. It becomes especially problematic during code refactoring or when a new variant is added to an enum.

By making your switch statements exhaustive, you can ensure better type safety and reduce the likelihood of bugs in your code.