Типы шаблонных литералов TypeScript
Типы шаблонных литералов основаны на типах строковых литералов и поддерживают создание новых строковых типов с помощью интерполяции.
Это позволяет TypeScript выполнять более точную проверку типов для строк, что подходит для таких сценариев, как имена событий, пути и имена классов.
SVG-диаграмма: типы шаблонных литералов
Зачем нужны типы шаблонных литералов
В разработке нам часто нужно обрабатывать форматированные строки, например имена событий (onClick), пути API (get:/users), имена CSS-классов (btn-primary-md) и т. д.
Обычный строковый тип не может точно описать эти форматы, но типы шаблонных литералов позволяют нам точно определить типы этих строк.
Это значительно повышает типобезопасность TypeScript и снижает количество ошибок времени выполнения.
Объяснение концепции:Типы шаблонных литералов используют обратные кавычки (`` ` ``) и
${}синтаксис интерполяции для определения строковых типов, подобно шаблонным строкам JavaScript, но используется на уровне типов.
Базовый синтаксис
Типы шаблонных литералов используют обратные кавычки и интерполяцию для определения типов.
Пример
type World = "world";
// Используем тип шаблонного литерала
// `Hello ${World}` эквивалентно "Hello world"
type Greeting = `Hello ${World}`;
// Можно присваивать только строки, соответствующие определению типа
var greeting: Greeting = "Hello world";
console.log("Приветствие: " + greeting);
Вывод:
问候: Hello world
Объяснение:Типы шаблонных литералов заменяют позицию интерполяции фактической строкой, создавая новый литеральный тип.
Встроенные служебные типы
TypeScript предоставляет четыре встроенных служебных типа для работы с регистром строк.
Пример
type UpperHello = Uppercase<"hello">; // "HELLO"
// Lowercase: Преобразует строку в нижний регистр
type LowerHELLO = Lowercase<"HELLO">; // "hello"
// Capitalize: Делает первую букву строки заглавной
type CapitalizedHello = Capitalize<"hello">; // "Hello"
// Uncapitalize: Делает первую букву строки строчной
type UncapitalizedHello = Uncapitalize<"Hello">; // "hello"
console.log("Верхний регистр: " + UpperHello);
console.log("Нижний регистр: " + LowerHELLO);
console.log("Сделать первую букву заглавной: " + CapitalizedHello);
console.log("Сделать первую букву строчной: " + UncapitalizedHello);
Вывод:
Uppercase: HELLO Lowercase: hello Capitalize: Hello Uncapitalize: hello
Сценарии использования:Эти служебные типы очень полезны в сценариях, требующих единообразного форматирования, например для имён событий и имён методов.
Типы событий
Типы шаблонных литералов можно использовать для точного определения типов имён событий.
Пример
// `on${Capitalize<string>}` генерирует строки, начинающиеся с "on" и с заглавной первой буквой
type EventName = `on${Capitalize<string>}`;
// `handle${Capitalize<string>}` генерирует строки, начинающиеся с "handle" и с заглавной первой буквой
type Handler = `handle${Capitalize<string>}`;
// Можно присваивать только строки, соответствующие формату
var clickEvent: EventName = "onClick";
var focusEvent: EventName = "onFocus";
var handler: Handler = "handleSubmit";
console.log("Event: " + clickEvent);
console.log("Обработчик: " + handler);
Вывод:
事件: onClick 处理器: handleSubmit
Преимущества:С помощью типов шаблонных литералов неправильные форматы, такие как "onclick" (в нижнем регистре), будут отклонены TypeScript.
Типы путей
Типы шаблонных литералов можно использовать для точного определения типов путей API.
Пример
type HttpMethod = "get" | "post" | "put" | "delete";
// Определить формат пути
type ApiEndpoint = `/${string}`; // Строки, начинающиеся со слэша
// Объединить в полный тип пути API
type ApiPath = `${HttpMethod}${ApiEndpoint}`;
// Можно присваивать только пути, соответствующие формату
var getUsers: ApiPath = "/get/users";
var createUser: ApiPath = "/post/users";
console.log("Путь: " + getUsers);
console.log("Путь: " + createUser);
Вывод:
路径: /get/users 路径: /post/users
Безопасность типов:Пути, такие как "/users" (без префикса метода), будут помечены TypeScript как ошибки.
Сложный пример
Типы шаблонных литералов могут объединять несколько union-типов, чтобы создавать все возможные комбинации.
Пример
// ${number} соответствует любому числу
type Row = `row${number}`;
type Row10 = Row; // row0, row1, row2... до row9...
// Объединение нескольких типов
type Variant = "primary" | "secondary";
type Size = "sm" | "md" | "lg";
// Это генерирует 6 комбинаций: btn-primary-sm, btn-primary-md, btn-primary-lg...
type ClassName = `btn-${Variant}-${Size}`;
// Можно присвоить только одну из 6 сгенерированных комбинаций
var className: ClassName = "btn-primary-md";
console.log("Имя класса: " + className);
Вывод:
类名: btn-primary-md
Взрыв комбинаций:Шаблонные литеральные типы автоматически разворачивают все комбинации. Если у типов-объединений много вариантов, сгенерированный тип может стать очень большим.
Пользовательские служебные типы
Вы можете создавать собственные служебные типы на основе шаблонных литералов.
Пример
// T — любая строка, P — добавляемый префикс
type Prefix<T extends string, P extends string> = `${P}${Capitalize<T>}`;
// Утилитарный тип для добавления суффикса
// T — любая строка, S — добавляемый суффикс
type Suffix<T extends string, S extends string> = `${Capitalize<T>}${S}`;
// Использование пользовательских утилитарных типов
type HandlerName = Prefix<"click", "on">;
type ButtonId = Suffix<"submit", "Btn">;
var handler: HandlerName = "onClick";
var id: ButtonId = "SubmitBtn";
console.log("Обработчик: " + handler);
console.log("ID: " + id);
Вывод:
处理器: onClick ID: SubmitBtn
Обобщённые шаблоны:Типы шаблонных литералов можно комбинировать с обобщениями для создания переиспользуемых служебных типов.
Примечания
- Типы интерполяции:В шаблоне
${}могут быть конкретными строками, union-типами, string, number и т. д. - Количество комбинаций:При комбинировании нескольких union-типов сгенерированный тип может быть очень большим
- Обработка регистра:Используйте встроенные служебные типы для обработки регистра строк
Лучшие практики:Использование типов шаблонных литералов для обработки строк с фиксированными форматами, такими как имена событий, пути и имена классов, позволяет достичь лучшей типобезопасности.
Итог
Типы шаблонных литералов — часть мощной системы типов TypeScript.
- Синтаксис шаблонов:Используйте
${T}интерполяцию для построения типов - Встроенные утилиты:Uppercase、Lowercase、Capitalize、Uncapitalize
- Сценарии использования:Имена событий, пути API, имена CSS-классов и т. д.
- Настройка:Создание переиспользуемых служебных типов
Рекомендация:В сценариях, требующих форматированных строк, отдавайте предпочтение использованию шаблонных литеральных типов для получения проверки типов во время компиляции.
Другие расширения