Урок 022 минуты чтения
in оператор при проверке union
На этой странице
Кратко
Оператор in проверяет наличие свойства в объекте и помогает TypeScript сузить union до варианта, где это свойство существует.
Вопрос
Как работает in оператор при проверке union?
Базовый пример
type Fish = { swim(): void };
type Bird = { fly(): void };
function move(animal: Fish | Bird) {
if ("swim" in animal) {
animal.swim();
} else {
animal.fly();
}
}После проверки "swim" in animal TypeScript понимает, что внутри if находится Fish.
Проверка объекта API
type Success = { data: string[] };
type Failure = { error: string };
function render(result: Success | Failure): string {
if ("data" in result) {
return result.data.join(", ");
}
return result.error;
}Важный нюанс
in проверяет существование свойства, включая свойства со значением undefined.
type A = { value?: string };
type B = { error: string };
function handle(input: A | B) {
if ("value" in input) {
// input - A, но input.value все еще string | undefined
}
}Когда лучше дискриминатор
Если ты сам проектируешь типы, поле kind или status обычно читается яснее.
type State =
| { status: "loading" }
| { status: "success"; data: string[] };Что важно помнить
"prop" in objсужает union до вариантов, где свойство есть.- Для вариантов, где свойство опционально, оно попадет в обе ветки сужения.
- Для
unknownс TS 4.9inдобавляет свойство к типу:"id" in valueдаетvalue.id. - Discriminated union с литеральным полем надежнее, чем проверка наличия свойств.
Мини-шпаргалка
"prop" in valueсужает объектный union.- Подходит, когда у вариантов разные поля.
- Опциональное поле после
inможет остатьсяT | undefined. - Для своих типов часто лучше discriminated union.
Документация
Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.