Урок 032 минуты чтения
Что делает asserts value is T?
На этой странице
Кратко
asserts value is T описывает функцию-утверждение: если функция завершилась без ошибки, TypeScript считает, что value имеет тип T.
Вопрос
Что делает asserts value is T?
Отличие от type guard
Type guard возвращает true или false.
function isString(value: unknown): value is string {
return typeof value === "string";
}Assertion-функция либо ничего не возвращает, либо бросает ошибку.
function assertString(value: unknown): asserts value is string {
if (typeof value !== "string") {
throw new Error("Expected string");
}
}Использование
function printUpper(value: unknown) {
assertString(value);
console.log(value.toUpperCase());
}После assertString(value) TypeScript считает value строкой.
Assertion для объекта
function assertUser(value: unknown): asserts value is User {
if (
typeof value !== "object" ||
value === null ||
!("id" in value) ||
!("name" in value)
) {
throw new Error("Expected User");
}
}Когда использовать
Assertion-функции удобны для валидации входных данных, инвариантов и кода, где дальнейшее выполнение не имеет смысла без правильного типа.
Что важно помнить
- Assertion function с
asserts value is Tбросает ошибку при неверном значении, а после вызова тип сужен. - Вариант
asserts valueсужает до truthy, какassert(condition). - Assertion function нужно объявлять с явным типом, и ее нельзя вызвать через переменную без аннотации.
- Как и type guard, тело функции компилятор не проверяет — ошибка в реализации даст ложное сужение.
Мини-шпаргалка
asserts value is Tсужает тип после успешного выполнения.- При ошибке функция обычно бросает
throw. - Не возвращает boolean для
if. - TypeScript доверяет такой функции, поэтому проверка должна быть честной.
Документация
Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.