Основы TypeScript

Содержание туториала по TypeScript Каждое значение в JavaScript имеет определенное поведение, которое можно наблюдать при выполнении различных операций. Звучит абстрактно, но в качестве быстрого примера рассмотрим некоторые операции, которые мы можем выполнять над переменной с именем message.

// Получение свойства 'toLowerCase' переменной 'message' и его вызов
message.toLowerCase();

// Вызов 'message'
message();

Разберем этот код. Первая исполняемая строка кода обращается к свойству с именем toLowerCase, а затем вызывает его. Вторая пытается вызвать message напрямую. Но предполагая, что мы не знаем значения message — а это довольно частая ситуация — мы не можем достоверно сказать, какие результаты мы получим, пытаясь запустить любой из этих вариантов. Поведение каждой операции полностью зависит от того, какое значение message мы имели ввиду.

• Можно ли вызвать message?
• Есть ли у него свойство toLowerCase?
• Если это так, можно ли вызвать toLowerCase?
• Если оба эти значения можно вызвать, что они возвращают?

Ответы на эти вопросы обычно возникают у нас в голове, когда мы пишем JavaScript код, и мы должны надеяться, что правильно поняли все детали. Допустим, message было определено следующим образом.

const message = 'Hello World!';

Как вы, наверное, догадались, если мы попытаемся запустить message.toLowerCase(), мы получим ту же строку, только в нижнем регистре. А как насчет второй строки кода? Если вы знакомы с JavaScript, вы знаете, что это вызовет исключение:

TypeError: message is not a function

Было бы здорово, если бы мы могли избежать подобных ошибок. Когда мы запускаем наш код, среда выполнения JavaScript выбирает, что делать, выясняя тип значения — каким поведение оно обладает и какие возможности у него есть. Это часть того, на что намекает TypeError — это говорит о том, что строку Hello World! нельзя вызывать как функцию. Для некоторых значений, таких как примитивы string и number, мы можем определить их тип во время выполнения с помощью оператора typeof. Но для других вещей, таких как функции, нет соответствующего механизма времени выполнения для определения их типов. Например, рассмотрим эту функцию:

function fn(x) {
  return x.flip();
}

Читая код, мы можем заметить, что эта функция будет работать только в том случае, если задан объект с вызываемым свойством flip, но JavaScript не отображает эту информацию таким образом, чтобы мы могли проверить ее во время выполнения кода. Единственный способ в чистом JavaScript узнать, что делает fn с конкретным значением — это вызвать его и посмотреть, что произойдет. Такое поведение затрудняет прогнозирование того, что будет делать код до его запуска, а это означает, что сложнее узнать, что будет делать ваш код, пока вы его пишете. С этой точки зрения тип — это понятие, описывающее, какие значения могут быть переданы в fn, а какие приведут к ошибке. JavaScript действительно обеспечивает только динамическую типизацию — нужно запустить код, чтобы увидеть, что происходит. Альтернативой является использование статической системы типов для предсказания того, какой код ожидается до его запуска.

Статическая проверка типов

Вспомните об ошибке TypeError, которую мы получили ранее при попытке вызвать строку как функцию. Большинству людей не нравится получать какие-либо ошибки при выполнении своего кода — это считается багами! И когда мы пишем новый код, мы делаем все возможное, чтобы избежать появления новых багов. Если мы добавим немного кода, сохраним наш файл, повторно запустим код и сразу же увидим ошибку, мы сможем быстро изолировать проблему; но это не всегда так. Возможно, мы недостаточно тщательно протестировали эту функцию, поэтому мы никогда не столкнемся с потенциальной ошибкой, которая будет выдана! Или, если бы нам посчастливилось стать свидетелями ошибки, мы могли бы в конечном итоге провести масштабный рефакторинг и добавить много другого кода, в котором нам пришлось бы разбираться. В идеале у нас мог бы быть инструмент, который помогал бы нам находить эти ошибки до запуска нашего кода. Это то, что делает статическая проверка типов, такая как TypeScript. Системы статических типов описывают формы и поведение наших значений при запуске наших программ. Средство проверки типов, такое как TypeScript, использует эту информацию и сообщает нам, когда что-то может пойти не так.

const message = "hello!";

message();
This expression is not callable.
  Type 'String' has no call signatures.

Запуск этого последнего примера с помощью TypeScript даст нам сообщение об ошибке, прежде чем мы запустим код.

Ошибки не вызывающие исключений

До сих пор мы обсуждали некоторые вещи, такие как ошибки времени выполнения — случаи, когда среда выполнения JavaScript сообщает нам, что считает что-то бессмысленным. Такие случаи возникают из-за того, что в спецификации ECMAScript есть четкие инструкции о том, как язык должен вести себя, когда он сталкивается с чем-то непредвиденным. Например, в спецификации сказано, что попытка вызвать что-то, что нельзя вызвать, должна выбросить ошибку. Возможно, это звучит как «очевидное поведение», но вы можете себе представить, что доступ к свойству, не существующему в объекте, также должен вызывать ошибку. Вместо этого JavaScript дает нам другое поведение и возвращает значение undefined:

const user = {
  name: 'Daniel',
  age: 26,
};
user.location; // возвращает undefined

В конечном счете, статическая система типов должна решить, какой код следует пометить как ошибку, даже если это валидный JavaScript, который не выдаст ошибку сразу. В TypeScript следующий код выдает ошибку о том, что location не определен:

const user = {
  name: 'Daniel',
  age: 26,
};

user.location;

// Property 'location' does not exist on type '{ name: string; age: number; }'.

Хотя иногда это подразумевает компромисс в том, что вы можете выразить, цель состоит в том, чтобы поймать законные ошибки в наших программах. И TypeScript отлавливает множество таких ошибок. Например: опечатки,

const announcement = 'Hello World!';

// Как быстро вы можете заметить опечатку?
announcement.toLocaleLowercase();
announcement.toLocalLowerCase();

// Возможно, мы имели ввиду это...
announcement.toLocaleLowerCase();

невызванные функции,

function flipCoin() {
  // Имелось ввиду Math.random()
  return Math.random < 0.5;

  // Оператор '<' не может применяться к типам '() => number' и 'number'.
}

или простые логические ошибки.

const value = Math.random() < 0.5 ? 'a' : 'b';
if (value !== 'a') {
  // ...
} else if (value === 'b') {
  // Это условие всегда будет возвращать 'false', т.к. типы '"a"' и '"b"' не пересекаются.
  // Не достижимый код
}

IDE инструменты TypeScript

TypeScript может обнаруживать баги, когда мы делаем ошибки в нашем коде. Это здорово, но TypeScript также может уберечь нас от этих ошибок. У средства проверки типов есть информация для проверки, например, обращаемся ли мы к нужным свойствам переменных и других свойств. Получив эту информацию, он также может начать предлагать свойства, которые вы, возможно, захотите использовать. Это означает, что TypeScript можно использовать и для редактирования кода, а ядро проверки типов может предоставлять сообщения об ошибках и автодополнять кода по мере ввода в редакторе. Это часть того, что люди часто имеют в виду, когда говорят об инструментах в TypeScript.

tsc компилятор TypeScript

Мы говорили о проверке типов, но мы еще не использовали его на практике. Давайте познакомимся с новым функционалом - это tsc - компилятором TypeScript. Сначала нам нужно установить его через npm.

npm install -g typescript

Эта команда устанавливает tsc - компилятор TypeScript - глобально. Вы можете использовать npx или аналогичные инструменты, если предпочитаете запускать tsc из локального node_modules. Теперь давайте перейдем в пустую папку и попробуем написать нашу первую программу на TypeScript: hello.ts:

// Приветствует мир
console.log('Hello world!');

Обратите внимание, что здесь нет никаких дополнений; эта программа «hello world» выглядит также, как написанная на JavaScript. А теперь давайте проверим эту программы на типы, выполнив команду tsc, которая была установлена пакетом typescript.

tsc hello.ts

Что произошло при вызове этого кода. Мы запустили tsc и ничего не произошло! Ошибок типов не было, поэтому мы не получили никакого сообщения в консоли, поскольку сообщать было не о чем. Но проверьте еще раз — вместо этого мы получили какой-то файл. Если мы посмотрим в текущий каталог, то увидим файл hello.js рядом с hello.ts. Это результат полученный из файла hello.ts после того, как tsc скомпилировал (или преобразовал) его в обычный файл JavaScript. И если мы проверим содержимое, то увидим, что выдал TypeScript после обработки файла .ts:

// Приветствует мир
console.log('Hello world!');

В этом случае очень мало того, что может преобразовать TypeScript, поэтому код выглядит идентично тому, что мы написали. Компилятор пытается создать чистый читаемый код, похожий на то, что написал бы человек. Хотя это не всегда так просто, TypeScript постоянно делает отступы, учитывает, когда наш код включает разные строки кода, и старается сохранять комментарии. А если бы мы добавили ошибку проверки типов? Давайте перепишем hello.ts:

function greet(person, date) {
  console.log(`Hello ${person}, today is ${date}!`);
}

greet('Brendan');

Если мы снова запустим tsc hello.ts, мы получим ошибку в командной строке.

Expected 2 arguments, but got 1.

TypeScript сообщает нам, что мы забыли передать аргумент функции greet, и это правильно. До сих пор мы писали только стандартный JavaScript, и тем не менее проверка типов по-прежнему могла находить проблемы в нашем коде.

Компиляция с отображением ошибок

В последнем примере вы могли не заметить, что наш файл hello.js снова изменился. Если мы откроем этот файл, мы увидим, что содержимое по-прежнему в основном выглядит так же, как наш входной файл. Это может показаться немного удивительным, учитывая тот факт, что tsc сообщил об ошибке в нашем коде, но это основано на одной из основных ценностей TypeScript: большую часть времени вы будете знать лучше, чем TypeScript. Повторим сказанное ранее: код проверки типов ограничивает количество программ, которые вы можете запускать, поэтому существует компромисс между тем, какие вещи программа проверки типов считает приемлемыми. В большинстве случаев это нормально, но бывают ситуации, когда эти проверки мешают. Например, представьте, что вы переносите код JavaScript на TypeScript и вносите ошибки проверки типов. В конце концов вы научитесь наводить порядок для системы проверки типов, но исходный код и так был JavaScript рабочим. Почему преобразование его в TypeScript должно помешать вам запустить его? Так что TypeScript не мешает вам. Конечно, со временем вы, возможно, захотите стать немного более защищенным от ошибок и заставить TypeScript действовать более строго. В этом случае вы можете использовать параметр компилятора noEmitOnError. Попробуйте изменить файл hello.ts и запустить tsc с этим флагом:

tsc --noEmitOnError hello.ts

Вы заметите, что hello.js больше не обновляется.

Явные типы

До сих пор мы не сообщали TypeScript, что такое person или date. Давайте отредактируем код, чтобы сообщить TypeScript, что person — это строка, а date должна быть объектом Date. Мы также будем использовать метод toDateString() для даты.

function greet(person: string, date: Date) {
  console.log(`Hello ${person}, today is ${date.toDateString()}!`);
}

Что мы сделали, так это добавили аннотации типа для person и date, чтобы описать, с какими типами значений может быть вызвана функция greet. Вы можете прочитать эту сигнатуру как "greet принимает person типа string и date типа Date». Таким образом, TypeScript может рассказать нам о других случаях, когда greet могло быть вызвано неправильно. Например...

function greet(person: string, date: Date) {
  console.log(`Hello ${person}, today is ${date.toDateString()}!`);
}

greet('Maddison', Date());
// Argument of type 'string' is not assignable to parameter of type 'Date'.

Хм? TypeScript сообщил об ошибке во втором аргументе, но почему? Удивительно, но вызов Date() в JavaScript возвращает строку. С другой стороны, создание Date с помощью new Date() фактически дает нам то, что мы ожидали. В любом случае, мы можем быстро исправить ошибку:

function greet(person: string, date: Date) {
  console.log(`Hello ${person}, today is ${date.toDateString()}!`);
}

greet('Maddison', new Date());

Имейте в виду, что нам не всегда нужно писать явные аннотации типов. Во многих случаях TypeScript может даже просто вывести (или «вычислить») типы за нас, даже если мы их опустим.

let msg = 'hello there!';

Если вы наведете курсор на переменную msg в IDE, появится всплывающее сообщение с информацией о типе. Несмотря на то, что мы не сказали TypeScript, что тип msg это string, он смог это понять. Это фича, и лучше не добавлять аннотации, когда система типов в любом случае выведет этот тип.

Удаление типов

Давайте посмотрим, что произойдет, когда мы скомпилируем приведенную выше функцию greeting с помощью tsc для вывода JavaScript:

'use strict';
function greet(person, date) {
  console.log(
    'Hello '.concat(person, ', today is ').concat(date.toDateString(), '!')
  );
}
greet('Maddison', new Date());

Обратите внимание на две вещи:

• Параметры person и date больше не имеют аннотаций типа.
• Наш шаблонный литерал — та строка, в которой использовались обратные кавычки (символ ```), — была преобразована в простые строки с конкатенацией.

Подробнее о втором пункте поговорим позже, а сейчас давайте сосредоточимся на первом пункте. Аннотации типов не являются частью JavaScript (или ECMAScript, если быть точнее), поэтому на самом деле не существует браузеров или других сред выполнения, которые могут просто запускать TypeScript без изменений. Вот почему TypeScript в первую очередь нуждается в компиляторе — ему нужен какой-то способ удалить или преобразовать любой специфичный для TypeScript код, чтобы вы могли его запустить. Большая часть кода, специфичного для TypeScript, стирается, и точно так же здесь были полностью стерты аннотации типов. Помните: аннотации типов никогда не изменяют поведение вашей программы во время выполнения.

Понижение версии

Еще одно отличие заключалось в том, что наша шаблонная строка была переписана из

`Hello ${person}, today is ${date.toDateString()}!`;

в

'Hello ' + person + ', today is ' + date.toDateString() + '!';

Почему это случилось? Шаблонный литерал — это фича версии ECMAScript под названием ECMAScript 2015 (он же ECMAScript 6, ES2015, ES6 и т.д.). TypeScript имеет возможность переписывать код с более новых версий ECMAScript на более старые, такие как ECMAScript 3 или ECMAScript 5 (также известные как ES3 и ES5). Этот процесс перехода от более новой или «более высокой» версии ECMAScript к более старой или «более низкой» версии иногда называют понижением уровня. По умолчанию TypeScript выводит ES3, чрезвычайно старую версию ECMAScript. Мы могли бы выбрать что-то более свежее, используя опцию target. Запуск с --target es2015 изменяет TypeScript на целевой ECMAScript 2015, что означает, что код должен работать везде, где поддерживается ECMAScript 2015. Таким образом, запуск tsc --target es2015 hello.ts дает нам следующий результат:

function greet(person, date) {
  console.log(`Hello ${person}, today is ${date.toDateString()}!`);
}
greet('Maddison', new Date());

Строгость

Разные пользователи приходят в TypeScript в поисках разных вещей в системе проверки типов. Некоторым людям нужно больше необязательности в применении TypeScript, которая может помочь проверить только некоторые части их программы и при этом иметь приличный инструментарий. Это стандартный опыт работы с TypeScript, где типы являются необязательными, для вывода используются самые мягкие типы, и нет проверки значений на потенциальные null/undefined. Подобно тому, как tsc выдает сообщения об ошибках, эти значения по умолчанию устанавливаются, чтобы не мешать вам. Если вы переносите существующий JavaScript, это может быть желательным первым шагом. Напротив, многие пользователи предпочитают, чтобы TypeScript проверял как можно больше сразу, и поэтому язык также предоставляет настройки строгости. Эти настройки строгости превращают статическую проверку типов из переключателя (независимо от того, проверяется ваш код или нет) во что-то более близкое к шкале. Чем больше вы поворачиваете этот переключатель, тем больше TypeScript будет проверять. Это может потребовать небольшой дополнительной работы, но в целом это окупается в долгосрочной перспективе и позволяет проводить более тщательные проверки и использовать более точные инструменты. Когда это возможно, новая кодовая база всегда должна включать эти проверки строгости. TypeScript имеет несколько флагов строгости проверки типов, которые можно включать и выключать, и все наши примеры будут написаны со всеми этими флагами, если не указано иное. Флаг strict в CLI "strict": true в tsconfig.json включает их все одновременно, но мы можем отказаться от них по отдельности. Вам следует знать о двух наиболее важных из них: noImplicitAny и strictNullChecks.

noImplicitAny

Напомним, что в некоторых местах TypeScript не пытается выводить за нас типы, а вместо этого возвращается к наиболее мягкому типу: any. Это не самое худшее, что может случиться — в конце концов, откат к any — это в любом случае обычный опыт работы с JavaScript. Однако использование any часто противоречит цели использования TypeScript. Чем более типизирована ваша программа, тем больше проверок и инструментов вы получите, а это означает, что вы столкнетесь с меньшим количеством ошибок при написании кода. Включение флага noImplicitAny вызовет ошибку для любых переменных, тип которых неявно выводится как any.

strictNullChecks

По умолчанию такие значения, как null и undefined, могут быть присвоены любому другому типу. Это может облегчить написание кода, но забывание обрабатывать null и undefined является причиной бесчисленных ошибок — некоторые считают это ошибкой на миллиард долларов! Флаг strictNullChecks делает обработку null и undefined более явной и избавляет нас от беспокойства о том, не забыли ли мы обработать null и undefined.

Содержание туториала по TypeScript Предположим, что у нас есть функция padLeft.

function padLeft(padding: number | string, input: string): string {
  throw new Error('Not implemented yet!');
}

Если padding является числом, оно будет рассматриваться как количество пробелов, которые мы хотим добавить перед input. Если padding является строкой, он должен просто добавлять padding перед input. Давайте попробуем реализовать логику, когда в padLeft передается padding как число.

function padLeft(padding: number | string, input: string) {
  return ' '.repeat(padding) + input;

  // Argument of type 'string | number' is not assignable to parameter of type 'number'.
  // Type 'string' is not assignable to type 'number'.

  // Аргумент типа 'string | number' не может быть присвоен параметру типа 'number'.
  // Тип 'string' не может быть присвоен типу 'number'.
}

TypeScript предупреждает нас, что добавление string | number в number может не дать нам того, что мы хотим, и это правильно. Другими словами, мы не проверяли явно, является ли padding числом, и не обрабатываем случай, когда это строка, так что давайте сделаем это.

function padLeft(padding: number | string, input: string) {
  if (typeof padding === 'number') {
    return ' '.repeat(padding) + input;
  }
  return padding + input;
}

Если не считать добавленных нами аннотаций типов, этот TypeScript код выглядит как JavaScript. Идея состоит в том, что система типов TypeScript направлена на то, чтобы максимально упростить написание JavaScript кода, без необходимости лезть вон из кожи, чтобы обеспечить безопасность типов. Хотя это может показаться не таким уж большим делом, на самом деле в этом коде скрывается много работы со стороны TypeScript. Подобно тому, как TypeScript анализирует значения во время выполнения с использованием статических типов, он накладывает анализ типов на конструкции потока управления во время выполнения JavaScript, такие как if/else, тернарные условия, циклы, проверки на истинность и т.д., которые могут влиять на эти типы. В нашей проверке if TypeScript видит typeof padding === 'number' и понимает это как особую форму кода, называемую защитой типа (type guard). TypeScript следует возможным путям выполнения, которые наши программы могут использовать для анализа наиболее конкретного возможного типа значения в данной позиции. Он рассматривает эти специальные проверки (называемые защитой типов) и присвоения, а процесс уточнения типов до более конкретных, чем объявленные, называется сужением (narrowing). Во многих IDE мы можем наблюдать за изменением этих типов, и мы даже будем делать это в наших примерах.

function padLeft(padding: number | string, input: string) {
  if (typeof padding === 'number') {
    return ' '.repeat(padding) + input;
    // при наведении курсора на padding => (parameter) padding: number
  }
  return padding + input;
  // в этом случае при наведении курсора на padding => (parameter) padding: string
}

Существует несколько различных конструкций, которые применяются в TypeScript для сужения.

Защитник типов typeof

Как мы видели, JavaScript поддерживает оператор typeof, который может дать очень базовую информацию о типе значений, во время выполнения. TypeScript ожидает, что это вернет определенный набор строк:

• "string"
• "number"
• "bigint"
• "boolean"
• "symbol"
• "undefined"
• "object"
• "function"

Как мы видели в случае с padLeft, этот оператор довольно часто встречается в ряде библиотек JavaScript, и TypeScript может понимать его для сужения типов в разных ветках кода. В TypeScript проверка значения, возвращаемого typeof, является защитой типа. Поскольку TypeScript понимает как typeof работает с разными значениями, он знает о некоторых причудах в JavaScript. Например, обратите внимание, что в приведенном выше списке typeof не возвращает строку null. Рассмторим следующий пример:

function printAll(strs: string | string[] | null) {
  if (typeof strs === 'object') {
    for (const s of strs) {
      // Object is possibly 'null'.
      // Возможно, объект 'null'.
      console.log(s);
    }
  } else if (typeof strs === 'string') {
    console.log(strs);
  } else {
    // ничего не делать
  }
}

В функции printAll мы пытаемся проверить, является ли strs объектом, чтобы узнать, является ли он типом массива (сейчас самое время подчеркнуть, что массивы являются объектными типами в JavaScript). Но оказывается, что в JavaScript typeof null на самом деле вернет "object"! Это одна из тех досадных исторических случайностей. Пользователи с достаточным опытом могут не удивиться, но не все сталкивались с этим в JavaScript. К счастью, TypeScript сообщает нам, что strs был сужен только до string[] | null вместо просто string[].

Проверка на истинность (Truthiness narrowing)

В JavaScript мы можем использовать любое выражение в условных выражениях, операторах &&, ||, операторах if, логических отрицаниях (!) и т.д. Например, операторы if не ожидают, что их условие всегда будет иметь логический тип.

function getUsersOnlineMessage(numUsersOnline: number) {
  if (numUsersOnline) {
    return `There are ${numUsersOnline} online now!`;
  }
  return "Nobody's here. :(";
}

В JavaScript такие конструкции, как if, сначала "приводят" свои условия к булевым значениям, а затем выбирают свои ответвления в зависимости от того, является ли результат истинным или ложным. Такие значения, как

• 0
• NaN
• "" (пустая строка)
• 0n (bigint версия нуля)
• null
• undefined

приводятся к false, а другие значения приводятся к true. Вы всегда можете привести значения к логическим значениям, применив к ним функцию Boolean или используя более короткое двойное логическое отрицание. (Последний имеет преимущество - TypeScript выводит узкий литеральный логический тип true, в то время как в первом варианте выводится логический тип boolean.)

// оба варианта имеют значение 'true'
Boolean('hello'); // type: boolean, value: true
!!'world'; // type: true, value: true

Довольно популярно использовать такое поведение, особенно для защиты от таких значений, как null или undefined. В качестве примера попробуем использовать его для нашей функции printAll.

function printAll(strs: string | string[] | null) {
  if (strs && typeof strs === 'object') {
    for (const s of strs) {
      console.log(s);
    }
  } else if (typeof strs === 'string') {
    console.log(strs);
  }
}

Обратите внимание, что мы избавились от приведенной выше ошибки, проверив, является ли strs истинным. Это, по крайней мере, защищает нас от ужасных ошибок при запуске нашего кода, например:

TypeError: null is not iterable

// TypeError: null не перечисляемый

Имейте в виду, однако, что проверка истинности примитивов часто может быть подвержена ошибкам. В качестве примера рассмотрим другой вариант printAll.

function printAll(strs: string | string[] | null) {
  // !!!!!!!!!!!!!!!!
  //  Не делайте так!
  //  Продолжайте чтение
  // !!!!!!!!!!!!!!!!
  if (strs) {
    if (typeof strs === 'object') {
      for (const s of strs) {
        console.log(s);
      }
    } else if (typeof strs === 'string') {
      console.log(strs);
    }
  }
}

Мы обернули все тело функции в проверку на истинность, но у такой реализации есть недостаток: мы больше не можем правильно обрабатывать случай пустой строки. И также рассмотрим пример с !.

function multiplyAll(
  values: number[] | undefined,
  factor: number
): number[] | undefined {
  if (!values) {
    return values;
  } else {
    return values.map((x) => x * factor);
  }
}

Сужение при проверке на равенство (Equality narrowing)

TypeScript также использует операторы switch и проверки на равенство, такие как ===, !==, == и != для сужения типов. Например:

function example(x: string | number, y: string | boolean) {
  if (x === y) {
    // Мы можем вызвать любой строковый метод у 'x' или 'y'.
    x.toUpperCase();
    // (method) String.toUpperCase(): string

    y.toLowerCase();
    // (method) String.toLowerCase(): string
  } else {
    console.log(x);
    // (parameter) x: string | number

    console.log(y);
    // (parameter) y: string | boolean
  }
}

Когда мы проверили, что x и y равны в приведенном выше примере, TypeScript узнал, что их типы также должны быть равны. Поскольку string — это единственный общий тип, который могут принимать как x, так и y, TypeScript знает, что x и y должны быть строкой в первой ветви. Также работает проверка конкретных литеральных значений (в отличие от переменных). В разделе Проверка на истинность мы написали функцию printAll, которая была подвержена ошибкам, потому что случайно неправильно обрабатывала пустые строки. Вместо этого мы могли бы сделать специальную проверку, чтобы заблокировать значения null, и TypeScript по-прежнему корректно удалял бы null из типа strs.

function printAll(strs: string | string[] | null) {
  if (strs !== null) {
    if (typeof strs === 'object') {
      for (const s of strs) {
        // (parameter) strs: string[]
        console.log(s);
      }
    } else if (typeof strs === 'string') {
      console.log(strs);
      // (parameter) strs: string
    }
  }
}

Cлабые проверки равенства в JavaScript с помощью == и != также корректно сужаются. Если вы не знакомы, проверка того, действительно ли что-то == null, не только проверяет, является ли это именно значением null, но также проверяет, является ли оно потенциально undefined. То же самое относится и к == undefined: он проверяет, является ли значение null или undefined.

interface Container {
  value: number | null | undefined;
}

function multiplyValue(container: Container, factor: number) {
  // Удаляем 'null' и 'undefined' из типа.
  if (container.value != null) {
    console.log(container.value);
    // (property) Container.value: number

    // Теперь можно безопасно умножить 'container.value'.
    container.value *= factor;
  }
}

Сужение типов с оператором in

В JavaScript есть оператор для определения наличия у объекта свойства с указанным именем: оператор in. TypeScript учитывает это как способ сузить число возможных типов. Например, кодом: "value" in x, где "value" — строковый литерал, а x — тип объединения. Ветвь с true сужает типы x, которые имеют либо необязательное, либо обязательное свойство value, а ветвь false сужает типы, которые имеют необязательное или отсутствующее свойство value.

type Fish = { swim: () => void };
type Bird = { fly: () => void };

function move(animal: Fish | Bird) {
  if ('swim' in animal) {
    return animal.swim();
  }

  return animal.fly();
}

Повторим, что необязательные свойства будут существовать в обеих ветках, например, человек может и плавать (swim), и летать (fly) (с соответствующим снаряжением):

type Fish = { swim: () => void };
type Bird = { fly: () => void };
type Human = { swim?: () => void; fly?: () => void };

function move(animal: Fish | Bird | Human) {
  if ('swim' in animal) {
    animal;
    // (parameter) animal: Fish | Human
  } else {
    animal;
    // (parameter) animal: Bird | Human
  }
}

Сужение типов с instanceof

В JavaScript есть оператор для проверки того, является ли значение «экземпляром» другого значения. В JavaScript x instanceof Foo проверяет, содержится ли Foo.prototype в цепочке прототипов x. Более подробно вернемся к этой теме, когда перейдем к классам. Как вы могли догадаться, instanceof также является защитой типов, а TypeScript сужает типы в ветках, защищенных instanceof.

function logValue(x: Date | string) {
  if (x instanceof Date) {
    console.log(x.toUTCString());
    //(parameter) x: Date
  } else {
    console.log(x.toUpperCase());
    // (parameter) x: string
  }
}

Присваивания (Assignments)

Как мы упоминали ранее, когда мы присваиваем значение любой переменной, TypeScript смотрит на правую часть присваивания и соответствующим образом сужает тип левой стороны.

let x = Math.random() < 0.5 ? 10 : 'hello world!';

let x: string | number;
x = 1;

console.log(x);
// let x: number

x = 'goodbye!';

console.log(x);
// let x: string

Обратите внимание, что каждое из этих присвоений допустимо. Несмотря на то, что наблюдаемый тип x изменился на number после нашего первого присваивания, мы по-прежнему могли присвоить x строку. Это связано с тем, что объявленный тип x — тип, с которого начинается x — это string | number, а присваиваемость всегда проверяется по объявленному типу. Если бы мы присвоили x значение boolean, мы бы увидели ошибку, поскольку это не было частью объявленного типа.

let x = Math.random() < 0.5 ? 10 : 'hello world!';

let x: string | number;
x = 1;

console.log(x);
// let x: number

x = true;
// Type 'boolean' is not assignable to type 'string | number'.
// Тип 'boolean' нельзя присвоить к типу 'string | number'.

console.log(x);
// let x: string | number

Анализ потока управления

До этого момента мы рассмотрели несколько основных примеров того, как TypeScript сужает типы ветках. Но на самом деле происходит нечто большее, чем просто обход каждой переменной и поиск защитников типов в if, while, условных выражениях и т.д. Например.

function padLeft(padding: number | string, input: string) {
  if (typeof padding === 'number') {
    return ' '.repeat(padding) + input;
  }
  return padding + input;
}

padLeft возвращает значение из своего первого блока if. TypeScript смог проанализировать этот код и увидеть, что остальная часть тела (return padding + input;) недостижима в случае, когда padding является числом. В результате удалось удалить number из типа padding (сужение от string | number до string) для остальной части функции. Этот анализ кода, основанный на достижимости, называется анализом потока управления (control flow analysis), и TypeScript использует этот анализ потока для сужения типов по мере того, как он сталкивается с защитой типов и присваиваниями. Когда переменная анализируется, поток управления может разделяться и объединяться снова и снова, и можно наблюдать, что эта переменная имеет разный тип в каждой точке.

function example() {
  let x: string | number | boolean;

  x = Math.random() < 0.5;

  console.log(x);
  // let x: boolean

  if (Math.random() < 0.5) {
    x = 'hello';
    console.log(x);
    // let x: string
  } else {
    x = 100;
    console.log(x);
    // let x: number
  }

  return x;
  // let x: string | number
}

Использование предикатов типа (type predicates)

До сих пор мы работали с существующими конструкциями JavaScript, чтобы сужать типы, однако иногда вам нужен более прямой контроль над тем, как типы меняются в вашем коде. Чтобы выразить определяемую пользователем защиту типа, нам просто нужно написать функцию, возвращаемый тип которой является предикатом типа:

function isFish(pet: Fish | Bird): pet is Fish {
  return (pet as Fish).swim !== undefined;
}

pet is Fish — наш предикат типа в этом примере. Предикат принимает форму parameterName is Type, где parameterName должно быть именем параметра из текущей сигнатуры функции. Каждый раз, когда isFish вызывается с некоторой переменной, TypeScript сужает эту переменную до этого конкретного типа, если исходный тип совместим.

// Теперь вызовы 'swim' и 'fly' - ок.
let pet = getSmallPet();

if (isFish(pet)) {
  pet.swim();
} else {
  pet.fly();
}

Обратите внимание, что TypeScript не только знает, что pet — это Fish в ветке if; он также знает, что в другой ветке у вас нет Fish, поэтому у вас должна быть Bird. Вы можете использовать защиту типа isFish для фильтрации массива Fish | Bird и получить массив состоящий из Fish:

const zoo: (Fish | Bird)[] = [getSmallPet(), getSmallPet(), getSmallPet()];
const underWater1: Fish[] = zoo.filter(isFish);
// или, тоже самое
const underWater2: Fish[] = zoo.filter(isFish) as Fish[];

// Предикат может нуждаться в повторении для более сложных примеров.
const underWater3: Fish[] = zoo.filter((pet): pet is Fish => {
  if (pet.name === 'sharkey') return false;
  return isFish(pet);
});

Исключающие объединения (discriminated unions)

Большинство примеров, которые мы рассмотрели ранее, были сосредоточены на сужении одиночных переменных с помощью простых типов, таких как string, boolean и number. Однако, большую часть времени в JavaScript мы будем иметь дело с немного более сложными структурами. Представим, что мы пытаемся описать такие фигуры, как круги и квадраты. Круги отслеживают свои радиусы, а квадраты отслеживают длины своих сторон. Мы будем использовать поле под названием kind, чтобы указать, с какой формой мы имеем дело. Вот первая реализация Shape.

interface Shape {
  kind: 'circle' | 'square';
  radius?: number;
  sideLength?: number;
}

Обратите внимание, что мы используем объединение типов строковых литералов: "circle" и "square". Используя "circle" | "square" вместо string, мы можем избежать проблем с орфографическими ошибками.

function handleShape(shape: Shape) {
  // "rect" не входит в "circle"` или `"square"
  if (shape.kind === 'rect') {
    // This condition will always return 'false' since the types '"circle" | "square"' and '"rect"' have no overlap.
    // Это условие всегда будет возвращать 'false', так как типы '"circle" | "square"' и '"rect"' не пересекаются.
    // ...
  }
}

Мы можем написать функцию getArea, которая применяет правильную логику в зависимости от того, имеет ли она дело с кругом или квадратом. Сначала попробуем разобраться с кругами.

function getArea(shape: Shape) {
  return Math.PI * shape.radius ** 2;
  // Object is possibly 'undefined'.
  // Объект, возможно, 'undefined'.
}

В strictNullChecks это выдает ошибку, что уместно, поскольку радиус может быть не определен. Но что, если мы выполним соответствующие проверки свойства kind?

function getArea(shape: Shape) {
  if (shape.kind === 'circle') {
    return Math.PI * shape.radius ** 2;
    // Object is possibly 'undefined'.
    // Объект, возможно, 'undefined'.
  }
}

И здесь TypeScript не знает, что делать. Мы достигли точки, когда знаем о наших значениях больше, чем средство проверки типов. Мы могли бы попытаться использовать ненулевое утверждение (! после shape.radius), чтобы сказать, что радиус определенно присутствует.

function getArea(shape: Shape) {
  if (shape.kind === 'circle') {
    return Math.PI * shape.radius! ** 2;
  }
}

Но это выглядит не очень. Нам пришлось немного покричать на средство проверки типов с этими ненулевыми утверждениями (!), чтобы убедить его, что shape.radius был определен, но эти утверждения подвержены ошибкам, если мы начнем менять код. Кроме того, за пределами strictNullChecks мы все равно можем случайно получить доступ к любому из этих полей (поскольку предполагается, что необязательные свойства всегда присутствуют при их чтении). Мы определенно можем сделать лучше.

Проблема с этой реализацией Shape заключается в том, что средство проверки типов не может узнать, присутствуют ли radius или sideLength на основе свойства kind. Нам нужно сообщить то, что мы знаем, системе проверки типов. Имея это в виду, давайте еще раз обратимся к определению Shape.

interface Circle {
  kind: 'circle';
  radius: number;
}

interface Square {
  kind: 'square';
  sideLength: number;
}

type Shape = Circle | Square;

Здесь мы правильно разделили Shape на два типа с разными значениями свойства kind, но radius и sideLength объявлены как обязательные свойства в соответствующих типах. Давайте посмотрим, что здесь происходит, когда мы пытаемся получить доступ к радиусу Shape.

function getArea(shape: Shape) {
  return Math.PI * shape.radius ** 2;
  // Property 'radius' does not exist on type 'Shape'.
  // Свойство 'radius' не существует в типе 'Square'.
}

Как и в случае с нашим первой реализацией Shape, это все еще ошибка. Когда радиус был необязательным, мы получили ошибку (с включенной strictNullChecks), потому что TypeScript не мог определить, присутствует ли свойство. Теперь, когда Shape является объединением, TypeScript сообщает нам, что Shape может быть квадратом, а у квадратов не определен радиус! Обе интерпретации верны, но только объединенный тип Shape вызовет ошибку независимо от того, как настроен strictNullChecks. Но что, если мы попытаемся снова проверить свойство kind?

function getArea(shape: Shape) {
  if (shape.kind === 'circle') {
    return Math.PI * shape.radius ** 2;
    // (parameter) shape: Circle
  }
}

Мы избавилась от ошибки. Когда каждый тип в объединении содержит общее свойство с литеральными типами, TypeScript считает это исключающим объединением (discriminated union) и может сузить круг членов объединения. В данном случае это общее свойство было kind (это то, что считается дискриминантным свойством Shape). Проверка того, является ли свойство kind = "circle", избавляет от всех типов в Shape, которые не имеют свойства kind с типом "circle". Эта суженный shape до типа Circle. Та же проверка работает и с операторами switch. Теперь мы можем попытаться написать полную реализацию getArea без каких-либо ! ненулевых утверждений.

function getArea(shape: Shape) {
  switch (shape.kind) {
    case 'circle':
      return Math.PI * shape.radius ** 2;
    // (parameter) shape: Circle

    case 'square':
      return shape.sideLength ** 2;
    // (parameter) shape: Square
  }
}

Передача правильной информации в TypeScript — что Circle и Square на самом деле были двумя отдельными типами с определенными полями kind — была крайне важна. Это позволяет нам писать типобезопасный код TypeScript. Кроме того, попробуйте поиграть с приведенным выше примером и удалить некоторые из возвращаемых ключевых слов. Вы увидите, что проверка типов может помочь избежать ошибок при случайном переходе через разные ветки в операторе switch. Исключающие объединения полезны не только для разделения кругов и квадратов. Они хороши для представления любой схемы обмена сообщениями в JavaScript, например, при отправке сообщений по сети (связь клиент-сервер) или для определения мутаций в библиотеках управления состоянием.

Тип never

При сужении можно уменьшить варианты объединения до такой степени, что можно убрать все возможные варианты и ничего не останется. В таких случаях TypeScript будет использовать тип never для представления состояния, которого не должно быть.

Исчерпывающие проверки (Exhaustiveness checking)

Тип never присваивается каждому типу; однако никакому типу нельзя присвоить значение never (кроме самого never). Это означает, что вы можете использовать сужение и полагаться на never для выполнения исчерпывающих проверок в операторе switch. Например, добавление значения по умолчанию к нашей функции getArea, которая пытается присвоить форме значение never, будет выполняться, если все возможные случаи не были обработаны.

type Shape = Circle | Square;

function getArea(shape: Shape) {
  switch (shape.kind) {
    case 'circle':
      return Math.PI * shape.radius ** 2;
    case 'square':
      return shape.sideLength ** 2;
    default:
      const _exhaustiveCheck: never = shape;
      return _exhaustiveCheck;
  }
}

Добавление нового члена в объединение Shape вызовет ошибку TypeScript:

interface Triangle {
  kind: 'triangle';
  sideLength: number;
}

type Shape = Circle | Square | Triangle;

function getArea(shape: Shape) {
  switch (shape.kind) {
    case 'circle':
      return Math.PI * shape.radius ** 2;
    case 'square':
      return shape.sideLength ** 2;
    default:
      const _exhaustiveCheck: never = shape;
      // Type 'Triangle' is not assignable to type 'never'.
      // Тип 'Triangle' нельзя присвоить типу 'never'.
      return _exhaustiveCheck;
  }
}