Как настроить Webpack, TypeScript и ts-loader
4 месяца назад·8 мин. на чтение
Здесть вы узнаете, как правильно настроить Webpack с использованием TypeScript и ts-loader. Шаг за шагом мы проведем вас через процесс интеграции TypeScript в ваш проект с помощью ts-loader, расскажем об основных конфигурационных параметрах и поделимся советами по оптимизации сборки.
Используемый во многих современных проектах, Webpack, является инструментом, который оптимизирует ресурсы приложения, чтобы они работали более эффективно на любом устройстве. Webpack помогает компилировать и объединять модули в единый файл, уменьшая количество HTTP-запросов и, как следствие, повышая производительность приложения.
С помощью Webpack код TypeScript компилируется в файл JavaScript, который удобен для браузера. С помощью загрузчиков (loaders) Webpack вы также можете конвертировать файлы Sass и Less в один CSS файл.
В этой статье мы узнаем, как использовать Webpack для компиляции TypeScript в JavaScript, объединять исходный код в один JavaScript файл и использовать source map исходного кода для отладки. Мы также рассмотрим, как использовать плагины Webpack.
Чтобы следовать инструкциям в этом руководстве, вам потребуется следующее:
- npm
- Node.js (≥v8.x)
- Редактор кода на ваш выбор (например, Visual Studio Code)
- Базовые знания TypeScript
Содержание
- Загрузчики Webpack
- Настройка Webpack и TypeScript
- Конфигурация Webpack
- Конфигурация TypeScript
- Конфигурация пакета
- Создание HTML-страниц с помощью HtmlWebpackPlugin
- Объединение CSS с MiniCssExtractPlugin
- Минимизация CSS
- Минификация JavaScript
- Использование CopyWebpackPlugin
- Отладка с помощью source map
Загрузчики Webpack
По умолчанию Webpack понимает только файлы JavaScript, рассматривая каждый импортированный файл как модуль. Webpack не может компилировать или объединять файлы, отличные от JavaScript, поэтому он использует загрузчики. Загрузчики сообщают Webpack, как компилировать и объединять статические ресурсы. Они используются для компиляции модулей TypeScript в JavaScript, обработки стилей приложений и даже линтинга кода с помощью ESLint. Некоторые загрузчики Webpack включают ts-loader, css-loader, style-loader и другие. Мы обсудим их позже в этом руководстве.Настройка Webpack и TypeScript
Начнем с настройки нашего проекта. Во-первых, на вашем компьютере должен быть установлен TypeScript. Чтобы установить TypeScript глобально, используйте следующую команду:Глобальная установка TypeScript избавляет от необходимости устанавливать TypeScript каждый раз, когда вы начинаете новый проект. Далее мы установим пакеты webpack и ts-loader в качестве зависимостей в нашем проекте:npm install -g typescript
npm init -y npm install -D webpack webpack-cli ts-loader webpack-dev-server
Конфигурация Webpack
По умолчанию Webpack не нуждается в конфигурационном файле. Предполагается, что точкой входа для вашего проекта являетсяsrc/index.js
и выведет минимизированный и оптимизированный результат в dist/main.js
.
Если вы хотите использовать плагины или загрузчики, то вам нужно будет использовать конфигурационный файл Webpack, позволяющий указать, как Webpack будет работать с вашим проектом, какие файлы компилировать и где будет находиться выходной файл.
Давайте добавим конфигурационный файл Webpack в наш проект. В корневой папке проекта создайте webpack.config.js
со следующими конфигурациями:
Давайте рассмотрим некоторые параметры конфигурации Webpack. Во-первых, опцияconst path = require('path'); module.exports = { entry: './src/index.ts', module: { rules: [ { test: /\.ts?$/, use: 'ts-loader', exclude: /node_modules/, }, ], }, resolve: { extensions: ['.tsx', '.ts', '.js'], }, output: { filename: 'bundle.js', path: path.resolve(__dirname, 'dist'), }, devServer: { static: path.join(__dirname, "dist"), compress: true, port: 4000, }, };
entry
является отправной точкой для приложения, где Webpack начинает строить граф зависимостей. Webpack перейдет к другим модулям в зависимости от входного файла.
Опция output
указывает Webpack, куда сохранять бандлы (результаты сборки), и позволяет присвоить файлу имя. Наконец, опция module указывает Webpack, как обрабатывать модули с определенными правилами с помощью загрузчиков.
Конфигурация TypeScript
Конфигурационный файл TypeScript определяет, как TypeScript будет компилироваться в JavaScript, и определяет различные параметры компилятора, необходимые для транспиляции TypeScript. В корневой папке проекта создайтеtsconfig.json
и добавьте следующие конфигурации:
{
"compilerOptions": {
"noImplicitAny": true,
"target": "ES5",
"module": "ES2015"
}
}
target
— это версия JavaScript, в которую вы хотите транспилировать TypeScript, а module
— это формат используемого оператора импорта. Вы можете установить модуль на CommonJS, ES6 или UMD, так как Webpack будет работать со всеми системами модулей.
Конфигурация проекта
Теперь нам нужно добавить сценарий Webpack, который будет запускатьwebpack.config.js
файл для нас.
Чтобы добавить сценарий Webpack, откройте package.json
и добавьте следующие скрипты в опцию script
:
- "dev": "webpack-dev-server --mode development",
- "build" : "webpack --mode production"
package.json
теперь будет содержать следующие параметры конфигурации:
Теперь давайте создадим простую программу TypeScript, которая будет вычитать два числа. Внутри папки{ "name": "webpack-setup", "version": "1.0.0", "description": "", "main": "src/index.ts", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", "dev": "webpack-dev-server --mode development", "build": "webpack --mode production" }, "keywords": [], "author": "", "license": "ISC", "devDependencies": { "css-loader": "^6.7.1", "html-webpack-plugin": "^5.5.0", "mini-css-extract-plugin": "^2.6.1", "ts-loader": "^9.4.1", "webpack": "^5.74.0", "webpack-cli": "^4.10.0", "webpack-dev-server": "^4.11.1" } }
src
создайте index.ts
и добавьте следующий код TypeScript:
Затем создайте еще один файлimport { subtract } from "./app"; function init() { const form = document.querySelector("form"); form?.addEventListener("submit", submitHandler); } function submitHandler(e: Event) { e.preventDefault(); const num1 = document.querySelector("input[name='firstnumber']") as HTMLInputElement; const num2 = document.querySelector("input[name='secondnumber']") as HTMLInputElement; const result = subtract(Number(num1.value), Number(num2.value)); const resultElement = document.querySelector("p"); if (resultElement) { resultElement.textContent = result.toString(); } } init();
app.ts
и добавьте следующий код:
Запуск скрипта dev запустит приложение в режиме разработки:export function subtract(firstnumber: number, secondnumber: number): number { return firstnumber - secondnumber; }
Запуск скрипта build запустит приложение в режиме для продакшен сборки:npm run develop
После выполнения команды build Webpack транспилирует два файла TypeScript в код JavaScript и сгенерируетnpm run build
bundle.js
в папке dist
.
Создание HTML-страниц с помощью HtmlWebpackPlugin
HtmlWebpackPlugin позволяет Webpack генерировать стандартную HTML-страницу, которая будет обслуживать сгенерированные файлы пакета. Когда имя файла пакета изменяется или хэшируется, HTMLWebpackPlugin обновляет имена файлов на HTML-странице. Во-первых, чтобы установить HtmlWebpackPlugin, выполните следующую команду:Далее нам нужно импортировать и добавить HtmlWebpackPlugin в опцию плагина конфигурации Webpack следующим образом:npm install html-webpack-plugin --save-dev
Шаблон представляет собой пользовательский HTML-файл, сгенерированный HtmlWebpackPlugin для вставки в HTML-страницу. Чтобы создать пользовательский HTML-код, внутри папки src создайтеconst HtmlWebpackPlugin = require("html-webpack-plugin"); const path = require('path'); module.exports = { entry: './src/index.ts', module: { rules: [ { test: /\.ts?$/, use: 'ts-loader', exclude: /node_modules/, } ], }, resolve: { extensions: ['.tsx', '.ts', '.js'], }, output: { filename: 'bundle.js', path: path.resolve(__dirname, 'dist'), }, plugins: [ new HtmlWebpackPlugin({ title: 'our project', template: 'src/custom.html' }) ], devServer: { static: path.join(__dirname, "dist"), compress: true, port: 4000, }, };
custom.html
и добавьте следующий HTML-код:
Вам не нужно включать скрипт или теги ссылок в пользовательский HTML. HtmlWebpackPlugin позаботится об этом, связав URL-адрес файла пакета со сгенерированной страницей. При запуске приложения в продакшен режиме файл<!DOCTYPE html> <html> <head> <meta charset="utf-8" /> </head> <body> <div class="cal"> <center> <form><br> <p>Result : <span id="display"></span></p> <input type="number" class="input" placeholder="Enter first number" name="firstnumber" value="1" min="1" min="9" /><br> <input type="number" class="input" placeholder="Enter second number" name="secondnumber" value="1" min="1" min="9" /><br><br> <button type="submit" class="button">Subtract</button> </form> </center> </div> </body> </html>
index.html
появится внутри папки dist
.
Собираем CSS с MiniCSSExtractPlugin
css-loader подсказывает Webpack, как работать с CSS. Он интерпретирует@import
и URL
как import/require
и резолвит их. css-loader позволяет Webpack скомпилировать все CSS файлы и конвертировать их в формат JavaScript.
Объединение CSS-файлов с загрузчиком стилей приводит к тому, что стили HTML-страниц не отвечают на запросы до тех пор, пока bundle.js
полностью не загружен. Загрузчик стилей внедряет CSS в DOM, но собранный JavaScript файл должен быть полностью загружен до внедрения стилей. Чтобы решить эту проблему, мы можем использовать MiniCssExtractPlugin.
MiniCssExtractPlugin извлекает файлы CSS и объединяет их в один bundle.css
файл. Это полезно для уменьшения размера ресурсов CSS и помогает избежать ненужных HTTP-запросов для их загрузки.
Мы можем установить css-loader и MiniCssExtractPlugin, выполнив в терминале следующие команды:
Теперь давайте добавим css-loader и MiniCssExtractPlugin вnpm install css-loader --save-dev npm install mini-css-extract-plugin --save-dev
webpack.config.js
файл.
В верхней части webpack.config.js
импортируйте модуль MiniCssExtractPlugin, используя приведенный ниже код:
Затем мы добавим новое правило в свойство rules следующим образом:const MiniCssExtractPlugin = require("mini-css-extract-plugin");
Когда css-loader компилирует все CSS файлы в JavaScript, MiniCssExtractPlugin.loader загружает CSS в CSS бандл. Далее мы добавим MiniCssExtractPlugin в опцию плагина следующим образом:… { test: /\.css$/, use: [MiniCssExtractPlugin.loader, "css-loader"] } …
Теперь, когда мы настроили css-loader и MiniCssExtractPlugin, давайте создадим CSS-файл и импортируем его вplugins: [ new HtmlWebpackPlugin({ title: 'our project', template: 'src/custom.html' }), new MiniCssExtractPlugin({ filename:"bundle.css" }) ]
index.ts
. Внутри папки src
создайте index.css
и добавьте следующий CSS-код:
Импортируйте CSS-стиль вform { background-color: pink; margin-top: 100px; border-radius: 40px; } .cal { width: 550px; height: 300px; margin-left: 400px; } .button { border-radius: 10px; margin-top: 20px; margin-bottom: 20px; } .input { border-radius: 10px; margin-top: 40px; }
index.ts
следующим образом:
Запускimport styles "./main.css"
npm run build
объединит CSS и применит его к index.html
. Когда вы запускаете приложение в режиме разработки и открываете http://localhost:4000
.
Минимизация CSS
Мы можем использовать css-minimizer-webpack-plugin, чтобы уменьшить размер файлов CSS, удалив неиспользуемые правила CSS и оставив только необходимые. css-minimizer-webpack-plugin находит все неиспользуемые стили. Затем этот плагин удалит эти неиспользуемые стили из вашего окончательного файла CSS, тем самым уменьшив его размер. Выполните приведенную ниже команду установки, чтобы установить css-minimizer-webpack-plugin:Добавим css-minimizer-webpack-plugin в конфигурацию Webpack. Во-первых, импортируйте плагин следующим образом:npm install css-minimizer-webpack-plugin --save-dev
Затем мы добавим новое свойство optimization в конфигурацию Webpack следующим образом:const CssMinimizerPlugin = require("css-minimizer-webpack-plugin");
Когда мы запускаем командуoptimization: { minimizer: [ new CssMinimizerPlugin() ], }
npm run build
, bundle.css
будет минифицироваться, но bundle.js
не будет. Стандартная минификация для bundle.js
была переопределена параметром minimizer
, который мы установили. Чтобы решить эту проблему, нам нужно минифицировать JavaScript с помощью TerserWebpackPlugin.
Минификация JavaScript
В текущей версии Webpack (на момент написания статьи 5.74.0) и более поздних, вам не нужно устанавливать TerserWebpackPlugin, так как он включен из коробки. Во-первых, мы должны импортировать TerserWebpackPlugin:Затем добавьте TerserPlugin в опцию минимизации следующим образом:const TerserPlugin = require("terser-webpack-plugin");
Если вы запустите скриптoptimization: { minimizer: [ new CssMinimizerPlugin(), new TerserPlugin() ], }
npm run build
и посмотрите на файлы в папке dist, вы увидите, что и JavaScript, и CSS минифицированы.
Использование CopyWebpackPlugin
Мы можем настроить Webpack для копирования ресурсов приложения из папки c исходными файлами в папку сборки dist с помощью CopyWebpackPlugin. Этот плагин может копировать такие файлы, как изображения, видео и другие ресурсы, в папкуdist
.
Установите CopyWebpackPlugin с помощью следующей команды:
Теперь добавим CopyWebpackPlugin в конфигурацию Webpack. Импортируйте плагин следующим образом:npm install copy-webpack-plugin --save-dev
Далее мы добавим CopyWebpackPlugin в опцию плагина. Свойствоconst CopyPlugin = require("copy-webpack-plugin");
from
— это папка, из которой мы будем копировать, а to
— это папка в каталоге dist, в которую нужно скопировать все файлы:
Создайте новую папку img и добавьте в нее изображения. После выполнения команды// ... plugins: [ new HtmlWebpackPlugin({ title: 'our project', template: 'src/custom.html' }), new MiniCssExtractPlugin({ filename: "bundle.css" }), new CopyPlugin({ patterns: [ { from: "src/img", to: "img" } ] }), ] // ...
npm run build
образы будут скопированы в dist/img
.
Отладка с помощью source map
Когда мы собираем пакет путем компиляции файлов TypeScript в файлы JavaScript (npm run build
), нам может потребоваться отладить и протестировать код с помощью DevTools нашего браузера.
При отладке кода инструментам разработки браузера вы заметите, что отображаются только собранные файлы. Всякий раз, когда в нашем коде TypeScript есть ошибка, она будет указана только в собранном файле, что затрудняет отслеживание ошибок в TypeScript для исправления. Тем не менее, с source map кода мы можем легко отлаживать TypeScript с помощью DevTools.
Source map кода отображают исходный файл, что упрощает отладку TypeScript и исправление кода и минимизированного кода JavaScript.
Файлы .map содержат сведения как об исходных файлах, так и о собранных файлах. DevTools использует этот файл для сопоставления исходного файла с собранным файлом.
Чтобы сгенерировать .map
для файлов пакета, нам нужно настроить как Webpack, так и TypeScript. В конфигурационном файле TypeScript добавьте sourceMap к параметру компилятора и присвойте ему значение true
:
Далее мы добавим свойство devtool в конфигурацию Webpack и установим его в{ "compilerOptions": { "noImplicitAny": true, "target": "ES5", "module": "ES2015", "sourceMap": true } }
true
, указав Webpack сгенерировать соответствующую карту исходного кода для каждого собранного файла:
Выполнив командуmodule.exports = { devtool: 'source-map', // ... }
npm run build
, вы сможете отлаживать исходный код напрямую.
Итоги
По мере того, как популярность TypeScript продолжает расти, Webpack стал важным вариантом для разработчиков, стремящихся оптимизировать свои проекты. С помощью плагинов Webpack мы можем оптимизировать ресурсы приложения TypeScript. В этом руководстве мы рассмотрели пошаговый процесс настройки Webpack с помощью TypeScript. Мы также узнали, как оптимизировать приложения TypeScript с помощью подключаемых модулей Webpack, и изучили отладку кода TypeScript с помощью карты исходного кода.Как типизировать с TypeScript?
2 года назад·14 мин. на чтение
В этой статье рассмотрим самые популярные типы, которые используются в JavaScript коде, и объясним способы описания этих типов в TypeScript.
Мы начнем с обзора самых основных и распространенных типов, с которыми вы можете столкнуться при написании JavaScript или TypeScript кода. Позже они сформируют основные строительные блоки для более сложных типов.
Примитивы:
В JavaScript есть три очень часто используемых примитива:
Тип
TypeScript также имеет специальный тип
Когда вы не указываете тип и TypeScript не может вывести его из контекста, компилятор обычно по умолчанию использует тип
В JavaScript есть два примитивных значения, которые используются для обозначения отсутствия или неинициализации значения:
Если
При включении strictNullChecks, когда значение равно
Оператор ненулевого утверждения (Non-null Assertion Operator, постфикс
TypeScript также имеет специальный синтаксис для удаления
Начиная с ES2020, в JavaScript есть примитив, используемый для очень больших целых чисел,
В JavaScript есть примитив, используемый для создания глобальной уникальной ссылки с помощью функции
Примитивы: string
, number
, boolean
В JavaScript есть три очень часто используемых примитива: string
, number
и boolean
. У каждого есть соответствующий тип в TypeScript. Как и следовало ожидать, это те же самые имена, которые вы увидели бы, если бы использовали оператор JavaScript typeof
для значений этих типов:
string
представляет строковые значения, такие как"Hello, world"
number
для чисел вроде42
. В JavaScript нет различий между целочисленными значениями и значениями с плавающей точкой, поэтому нет эквивалентаint
илиfloat
— все простоnumber
boolean
для двух значенийtrue
иfalse
String
, Number
и Boolean
(начинающиеся с заглавных букв) допустимы, но относятся к некоторым специальным встроенным типам, которые очень редко встречаются в коде. Всегда используйте типы string
, number
или boolean
.
Типизация массивов
Чтобы указать тип массива, например[1, 2, 3]
, вы можете использовать синтаксис number[]
; этот синтаксис работает для любого типа (например, string[]
— это массив строк и т.д.). Вы также можете встретить синтаксис Array<number>
, что означает то же самое.
Обратите внимание, что [number]
— это не массив чисел, а кортеж (tuple).
Тип any
TypeScript также имеет специальный тип any
, который вы можете использовать всякий раз, когда вы не хотите, чтобы определенное значение вызывало ошибки проверки типов.
Когда значение имеет тип any
, вы можете получить доступ к любым его свойствам (которые, в свою очередь, будут иметь тип any
), вызвать его как функцию, присвоить ему значения любого типа или почти все что угодно. Это валидный синтаксис:
Типlet obj: any = { x: 0 }; // Ни одна из следующих строк кода не вызовет ошибок компилятора. // Использование any отключает все дальнейшие проверки типов и предполагается, что // вы знаете эти сценарии лучше, чем TypeScript. obj.foo(); obj(); obj.bar = 100; obj = 'hello'; const n: number = obj;
any
полезен, когда вы не хотите записывать длинный тип. Тип any
нужен только для того, чтобы убедить TypeScript в том, что конкретная строка кода валидна.
noImplicitAny
Когда вы не указываете тип и TypeScript не может вывести его из контекста, компилятор обычно по умолчанию использует тип any
.
Обычно этого следует избегать, потому что тип any
не проверяется. Используйте флаг компилятора noImplicitAny
, чтобы пометить любое неявное значение any
как ошибку.
Аннотации типов переменных
Когда вы объявляете переменную с помощьюconst
, var
или let
, вы можете дополнительно добавить аннотацию типа, чтобы явно указать тип переменной:
TypeScript не использует объявления в стиле «типы слева», такие какlet myName: string = 'Alice';
int x = 0;
Аннотации типа всегда будут находится после.
Однако в большинстве случаев в этом нет необходимости. Везде, где это возможно, TypeScript пытается автоматически определить типы в вашем коде. Например, тип переменной выводится на основе типа ее инициализатора:
По большей части вам не нужно явно изучать правила вывода. Если вы только начинаете, попробуйте использовать меньше аннотаций типов — вы удивитесь, как мало нужно для TypeScript, чтобы он понимал, что происходит.// Аннотации типа не требуются — тип 'myName' выводится как 'string' let myName = 'Alice';
Как типизировать функции в TypeScript?
Функции — это основное средство для работы с данными в JavaScript. TypeScript позволяет указывать типы как входных, так и выходных значений функций.Аннотации типов параметров
Когда вы объявляете функцию, вы можете добавить аннотации типа после каждого параметра, чтобы объявить, какие типы параметров принимает функция. Аннотации типа параметра идут после имени параметра:Когда параметр имеет аннотацию типа, будут проверены аргументы этой функции:// Аннотация типа параметра function greet(name: string) { console.log('Hello, ' + name.toUpperCase() + '!!'); }
Даже если вы не указали аннотации типов для параметров, TypeScript все равно проверит, что вы передали правильное количество аргументов.// При вызове возникнет ошибка времени выполнения greet(42); // Argument of type 'number' is not assignable to parameter of type 'string'.
Аннотации типа возвращаемого значения
Вы также можете добавить аннотации типа возвращаемого значения. Аннотации типа возвращаемого значения добавляется после списка параметров:Подобно аннотациям типа переменной, вам обычно не нужна аннотация типа возвращаемого значения, потому что TypeScript будет делать вывод о типе возвращаемого значения функции на основе ее оператораfunction getFavoriteNumber(): number { return 26; }
return
. Аннотация типа в приведенном выше примере ничего не меняет. Некоторые кодовые базы явно указывают тип возвращаемого значения для документирования, для предотвращения случайных изменений или просто из-за личных предпочтений.
Анонимные функции
Анонимные функции немного отличаются от объявлений обычных функций. Когда функция появляется в месте, где TypeScript может определить, как она будет вызываться, параметрам этой функции автоматически присваиваются типы. Например:Несмотря на то, что у параметра// Здесь нет аннотаций типов, но TypeScript может обнаружить ошибку const names = ['Alice', 'Bob', 'Eve']; // Определение типа на основе контекста names.forEach(function (s) { console.log(s.toUppercase()); // Property 'toUppercase' does not exist on type 'string'. Did you mean 'toUpperCase'? // В типе 'string' нет свойства 'toUppercase'. Возможно, вы имели ввиду 'toUpperСase'? }); // Определение типа на основе контекста вызова функции также работает и для стрелочных функций names.forEach((s) => { console.log(s.toUppercase()); // Property 'toUppercase' does not exist on type 'string'. Did you mean 'toUpperCase'? // В типе 'string' нет свойства 'toUppercase'. Возможно, вы имели ввиду 'toUpperСase'? });
s
не было аннотации типа, TypeScript использовал типы функции forEach
вместе с предполагаемым типом массива, чтобы определить тип, который будет иметь s
.
Этот процесс называется контекстной типизацией, потому что контекст, в котором возникла функция, сообщает, какой тип она должна иметь.
Как и в случае с правилами вывода, вам не нужно явно знать, как это происходит, но понимание того, что это действительно происходит, может помочь вам заметить, когда аннотации типов не нужны. Позже мы увидим больше примеров того, как контекст, в котором встречается значение, может повлиять на его тип.
Как типизировать объекты в TypeScript?
Помимо примитивов, наиболее распространенным типом, с которым вы столкнетесь, является объект. Это относится к любому значению JavaScript со свойствами. Чтобы определить тип объекта, мы просто перечисляем его свойства и их типы. Например, вот функция, которая принимает объект точку:Здесь мы типизировали параметр двумя свойствами —// Аннотация типа параметра является типом объекта function printCoord(pt: { x: number; y: number }) { console.log("The coordinate's x value is " + pt.x); console.log("The coordinate's y value is " + pt.y); } printCoord({ x: 3, y: 7 });
x
и y
— оба типа number
. Вы можете использовать ,
или ;
для разделения свойств, а последний разделитель необязателен.
Указание типа каждого свойства также необязательно. Если вы не укажете тип, он будет считаться any
.
Необязательные свойства
Типы объектов также могут указывать, что некоторые или все их свойства являются необязательными. Для этого добавьте?
после имени свойства:
В JavaScript, если вы обращаетесь к несуществующему свойству, вы получите значениеfunction printName(obj: { first: string; last?: string }) { // ... } // Следующие вызовы не вызовут ошибок printName({ first: 'Bob' }); printName({ first: 'Alice', last: 'Alisson' });
undefined
, а не ошибку времени выполнения. Из-за этого, когда вы читаете из необязательного свойства, вам придется проверять его на undefined
перед его использованием.
function printName(obj: { first: string; last?: string }) { // Ошибка, если obj.last не предоставлен: console.log(obj.last.toUpperCase()); Object is possibly 'undefined'. if (obj.last !== undefined) { // OK console.log(obj.last.toUpperCase()); } // Безопасная альтернатива с использованием современного синтаксиса JavaScript: console.log(obj.last?.toUpperCase()); }
Объединение типов (Unions)
Система типов TypeScript позволяет вам создавать новые типы из существующих, используя большое количество операторов. Теперь, когда мы знаем, как писать несколько типов, пора начать комбинировать их интересными способами.Определение объединенного типа
Первый способ комбинирования типов, который вы встретить - это объединение типов. Объединение типов - это тип, сформированный из двух или более других типов, представляющих значения, которые могут быть любым из этих типов. Давайте напишем функцию, которая может работать со строками или числами:function printId(id: number | string) { console.log('Your ID is: ' + id); } // Работает printId(101); // Работает printId('202'); // Ошибка printId({ myID: 22342 }); // Argument of type '{ myID: number; }' is not assignable to parameter of type 'string | number'.
Работа с объединенными типами
TypeScript разрешит операцию только в том случае, если она действительна для каждого члена объединения. Например, если у вас есть объединениеstring | number
, вы не можете использовать методы, доступные только для string
:
Решение состоит в том, чтобы сузить объединение с помощью кода, как в JavaScript без аннотаций типов. Сужение происходит, когда TypeScript может определить более конкретный тип для значения на основе структуры кода. Например, TypeScript знает, что только строковое значение будет иметь значениеfunction printId(id: number | string) { console.log(id.toUpperCase()); // Property 'toUpperCase' does not exist on type 'string | number'. // Property 'toUpperCase' does not exist on type 'number'. }
"string"
при применении оператора typeof
:
Другой пример — использование такой функции, какfunction printId(id: number | string) { if (typeof id === 'string') { // Здесь id имеет тип 'string' console.log(id.toUpperCase()); } else { // Здесь id имеет тип 'number' console.log(id); } }
Array.isArray
:
Обратите внимание, что в веткеfunction welcomePeople(x: string[] | string) { if (Array.isArray(x)) { // Здесь: 'x' это 'string[]' console.log('Hello, ' + x.join(' and ')); } else { // Здесь: 'x' это 'string' console.log('Welcome lone traveler ' + x); } }
else
нам не нужно делать ничего особенного — если x
не является string[]
, то это должна быть строка.
Иногда у вас будет объединение, в котором все члены имеют что-то общее. Например, и массивы, и строки имеют метод slice
. Если у каждого члена объединения есть общее свойство, вы можете использовать это свойство без сужения:
Может сбивать с толку тот факт, что объединение типов имеет пересечение свойств этих типов. Это не случайно — название// Возвращаемый тип определяется из number[] | string function getFirstThree(x: number[] | string) { return x.slice(0, 3); }
union
происходит из теории типов. Объединение number | string
состоит из объединения значений каждого типа. Обратите внимание, что для двух множеств с соответствующими фактами о каждом множестве к объединению самих множеств применимо только пересечение этих фактов. Например, если бы у нас была комната с высокими людьми в шляпах и другая комната с говорящими по-испански в шляпах, после объединения этих комнат единственное, что мы знаем о каждом человеке, это то, что он должен быть в шляпе.
Псевдонимы типов (алиасы, aliases)
Мы использовали типы объектов и типы объединения, записывая их непосредственно в аннотациях типов. Это удобно, но часто хочется использовать один и тот же тип более одного раза и ссылаться на него по одному имени. Псевдоним типа — это именно то, что является именем для любого типа. Синтаксис псевдонима типа:Вы можете использовать псевдоним типа, чтобы дать имя любому типу, а не только объектному типу. Например, псевдоним типа может включать тип объединения:type Point = { x: number; y: number; }; // Тоже самое как и в прошлом примере function printCoord(pt: Point) { console.log("The coordinate's x value is " + pt.x); console.log("The coordinate's y value is " + pt.y); } printCoord({ x: 100, y: 100 });
Обратите внимание, что псевдонимы — это всего лишь псевдонимы — вы не можете использовать псевдонимы типов для создания разных/отличных «версий» одного и того же типа. Другими словами, этот код может выглядеть недопустимым, но в соответствии с TypeScript это нормально, потому что оба типа являются псевдонимами для одного и того же типа:type ID = number | string;
type UserInputSanitizedString = string; function sanitizeInput(str: string): UserInputSanitizedString { return sanitize(str); } // Значение типа UserInputSanitizedString let userInput = sanitizeInput(getInput()); // может также присваивать строку userInput = 'new input';
Интерфейсы
Объявление интерфейса — это еще один способ объявить тип объекта:Точно так же, как когда мы использовали псевдоним типа выше, пример работает так же, как если бы мы использовали анонимный тип объекта. TypeScript заботится только о структуре значения, которое мы передали вinterface Point { x: number; y: number; } function printCoord(pt: Point) { console.log("The coordinate's x value is " + pt.x); console.log("The coordinate's y value is " + pt.y); } printCoord({ x: 100, y: 100 });
printCoord
, — то, что оно имеет ожидаемые свойства. Занимаясь только структурой и возможностями типов, мы называем TypeScript структурно типизированной (structurally typed) системой типов.
Различия типа и интерфейса в TypeScript
Псевдонимы типов (type) и интерфейсы очень похожи, и во многих случаях вы можете свободно выбирать между ними. Почти все возможности интерфейса доступны в типе, ключевое отличие состоит в том, что тип нельзя повторно открыть для добавления новых свойств по сравнению с интерфейсом, который всегда расширяем. Расширение интерфейса:Расширение типа через пересечения:interface Animal { name: string; } interface Bear extends Animal { honey: boolean; } const bear = getBear(); bear.name; bear.honey;
Добавление новых полей в существующий интерфейс:type Animal = { name: string; }; type Bear = Animal & { honey: boolean; }; const bear = getBear(); bear.name; bear.honey;
Тип нельзя изменить после создания:interface Window { title: string; } interface Window { ts: TypeScriptAPI; } const src = 'const a = "Hello World"'; window.ts.transpileModule(src, {});
Вы узнаете больше об этих понятиях в следующих главах, так что не беспокойтесь, если вы не сразу все поймете.type Window = { title: string; }; type Window = { ts: TypeScriptAPI; }; // Error: Duplicate identifier 'Window'
- До TypeScript версии 4.2 имена псевдонимов могут появляться в сообщениях об ошибках, иногда вместо эквивалентного анонимного типа. Интерфейсы всегда будут иметь имена в сообщениях об ошибках.
- Псевдонимы типов не могут участвовать в слиянии объявлений, но интерфейсы могут.
- Интерфейсы могут использоваться только для объявления форм объектов, а не для переименования примитивов.
- Имена интерфейсов всегда будут отображаться в исходном виде в сообщениях об ошибках, но только тогда, когда они используются по имени.
Утверждения типа (Type Assertions)
Иногда у вас будет информация о типе значения, о котором TypeScript не может узнать. Например, если вы используетеdocument.getElementById
, TypeScript знает только, что это вернет какой-то HTMLElement
, но вы можете знать, что на вашей странице всегда будет HTMLCanvasElement
с заданным идентификатором.
В этой ситуации вы можете использовать утверждение типа, чтобы указать более конкретный тип:
Подобно аннотации типа, утверждения типа удаляются компилятором и не влияют на поведение вашего кода во время выполнения. Вы также можете использовать синтаксис угловых скобок (кроме случаев, когда код находится в файлеconst myCanvas = document.getElementById('main_canvas') as HTMLCanvasElement;
.tsx
), что эквивалентно:
TypeScript допускает только утверждения типа, которые преобразуются в более конкретную или менее конкретную версию типа. Это правило предотвращает «невозможные» приведения, такие как:const myCanvas = <HTMLCanvasElement>document.getElementById('main_canvas');
Иногда это правило может быть слишком консервативным и запрещать более сложные приведения, которые могут быть действительными. Если это произойдет, вы можете использовать два утверждения, сначала дляconst x = 'hello' as number; // Conversion of type 'string' to type 'number' may be a mistake because neither type sufficiently overlaps with the other. If this was intentional, convert the expression to 'unknown' first. // Преобразование типа 'string' в тип 'number' может быть ошибкой, поскольку ни один из типов в достаточной степени не перекрывает другой. Если это было сделано намеренно, сначала преобразуйте выражение к типу 'unknown'.
any
(или unknown
), затем для нужного типа:
const a = expr as any as T;
Литеральные типы (Literal Types)
В дополнение к общим типамstring
и number
мы можем ссылаться на определенные строки и числа в позициях типа.
Один из способов это представить — рассмотреть, как в JavaScript существуют различные способы объявления переменных. И var
, и let
позволяют изменять содержимое переменной, а const
— нет. Это отражено в том, как TypeScript создает типы для литералов.
Сами по себе литеральные типы не очень ценны:let changingString = 'Hello World'; changingString = 'Olá Mundo'; // Поскольку `changingString` может представлять любую возможную строку, именно так TypeScript описывает ее в системе типов const constantString = 'Hello World'; // Поскольку `constantString` может представлять только 1 возможную строку, она имеет буквальное представление типа.
Нет особого смысла иметь переменную, которая может иметь только одно значение. Но комбинируя литералы в объединения, вы можете выразить гораздо более полезную концепцию — например, функции, которые принимают только определенный набор известных значений:let x: 'hello' = 'hello'; // Работает x = 'hello'; // ... x = 'howdy'; // Type '"howdy"' is not assignable to type '"hello"'. // Тип '"howdy"' нельзя назначить типу '"hello"'.
Типы числовых литералов работают так же:function printText(s: string, alignment: 'left' | 'right' | 'center') { // ... } printText('Hello, world', 'left'); printText("G'day, mate", 'centre'); // Argument of type '"centre"' is not assignable to parameter of type '"left" | "right" | "center"'. // Аргумент типа '"centre"' нельзя назначить параметру типа '"left" | "right" | "center"'.
Конечно, вы можете комбинировать их с нелитеральными типами:function compare(a: string, b: string): -1 | 0 | 1 { return a === b ? 0 : a > b ? 1 : -1; }
Есть еще один вид литералов:interface Options { width: number; } function configure(x: Options | 'auto') { // ... } configure({ width: 100 }); configure('auto'); configure('automatic'); // Argument of type '"automatic"' is not assignable to parameter of type 'Options | "auto"'. // Аргумент типа '"automatic"' нельзя назначить параметру типа 'Options | "auto"'.
boolean
литералы. Есть только два типа логических литералов, и, как вы могли догадаться, это true
и false
. Сам тип boolean
на самом деле является просто псевдонимом объединения true | false
.
Вывод литералов
Когда вы инициализируете переменную объектом, TypeScript предполагает, что свойства этого объекта могут изменить значения позже. Например, если вы написали такой код:TypeScript не считает, что присвоениеconst obj = { counter: 0 }; if (someCondition) { obj.counter = 1; }
1
полю, которое ранее имело 0
, является ошибкой. Другой способ выразить тоже самое это то, что obj.counter
должен иметь тип number
, а не 0
, потому что типы используются для определения поведения как при чтении, так и при записи.
То же самое относится и к строкам:
В приведенном выше примереconst req = { url: 'https://example.com', method: 'GET' }; handleRequest(req.url, req.method); // Argument of type 'string' is not assignable to parameter of type '"GET" | "POST"'. // Аргумент типа 'string' нельзя назначить параметру типа '"GET" | "POST"'.
req.method
подразумевается как строка, а не как "GET"
. Поскольку код можно обработать между созданием req
и вызовом handleRequest
, который может назначить новую строку, например "GUESS"
, для req.method
, TypeScript считает, что этот код содержит ошибку.
Есть два способа решить это.
- Вы можете изменить вывод, добавив утверждение типа в любом месте:
Изменение 1 означает: "Я говорю, что// Изменение 1: const req = { url: 'https://example.com', method: 'GET' as 'GET' }; // Изменение 2: handleRequest(req.url, req.method as 'GET');
req.method
всегда имеет литеральный тип "GET"
", предотвращая возможное назначение "GUESS"
этому полю после этого. Изменение 2 означает "Я знаю, что req.method
имеет значение "GET"
".
Вы можете использовать as const
для преобразования всего объекта в литералы типов:
Суффиксconst req = { url: 'https://example.com', method: 'GET' } as const; handleRequest(req.url, req.method);
as const
действует как const
, но для системы типов, гарантируя, что всем свойствам будет присвоен литеральный тип, а не более общая версия, такая как string
или number
.
null
и undefined
В JavaScript есть два примитивных значения, которые используются для обозначения отсутствия или неинициализации значения: null
и undefined
.
TypeScript имеет два соответствующих типа с соответствующими именами. Поведение этих типов зависит от того, включена ли у вас опция strictNullChecks
.
strictNullChecks
выключен
Если strictNullChecks
выключен, значения, которые могут быть null
или undefined
, по-прежнему могут быть доступны в обычном режиме, а значения null
или undefined
могут быть присвоены свойству любого типа. Это похоже на то, как ведут себя языки без проверок на null
(например, C#, Java). Отсутствие проверки этих значений, как правило, является основным источником ошибок; мы всегда рекомендуем включать strictNullChecks
, если это целесообразно в кодовой базе.
strictNullChecks
включен
При включении strictNullChecks, когда значение равно null
или undefined
, вам нужно будет проверить эти значения, прежде чем использовать методы или свойства для этого значения. Точно так же, как проверка на undefined
перед использованием необязательного свойства, мы можем использовать сужение для проверки значений, которые могут быть null
:
function doSomething(x: string | null) { if (x === null) { // … } else { console.log('Hello, ' + x.toUpperCase()); } }
Оператор ненулевого утверждения (Non-null Assertion Operator, постфикс !
)
TypeScript также имеет специальный синтаксис для удаления null
и undefined
из типа без какой-либо явной проверки. Добавление !
после выражения фактически является утверждением того, что значение не является null
или undefined
:
Как и другие утверждения типа, это не меняет поведение вашего кода во время выполнения, поэтому важно использовать толькоfunction liveDangerously(x?: number | null) { // No error console.log(x!.toFixed()); }
!
когда вы знаете, что значение не может быть null
или undefined
.
Что такое Enums в TypeScript (Перечисления)?
Перечисления — это функциональность, добавленная TypeScript, которая позволяет описывать значение, которое может быть одной из множества возможных именованных констант. В отличие от большинства возможностей TypeScript, это не дополнение к JavaScript на уровне типов, а нечто, добавленное к языку и среде выполнения.enum Direction { Up, Down, Left, Right, }
Менее распространенные примитивы
Стоит упомянуть остальные примитивы в JavaScript, представленные в системе типов.bigint
Начиная с ES2020, в JavaScript есть примитив, используемый для очень больших целых чисел, BigInt
:
// Создание значения bigint через функцию BigInt const oneHundred: bigint = BigInt(100); // Создание значения BigInt через литеральный синтаксис const anotherHundred: bigint = 100n;
symbol
В JavaScript есть примитив, используемый для создания глобальной уникальной ссылки с помощью функции Symbol()
:
const firstName = Symbol('name'); const secondName = Symbol('name'); if (firstName === secondName) { // Это условие всегда будет возвращать 'false', поскольку типы 'typeof firstName' и 'typeof secondName' не пересекаются. }