Теория: Литералы

В программировании встречаются ситуации, когда мы работаем с ограниченным набором значений какого-то типа, например, с определенными строками. В них могут входить справочные данные, статусы и так далее. Как мог бы выглядеть статус заказа:

Created
Paid
Shipped
Delivered

Код, который работает с этими данными, будет сохранять их в базу данных, отправлять и получать по сети и проверять статус заказа. Если использовать общий тип для таких данных, например, string, то появляется множество проблем:

• Компилятор не увидит опечаток
• Компилятор не увидит использование недопустимых статусов
• Мы не сможем увидеть, какие статусы у нас есть
• Не сработает автоматическое дополнение в редакторе

Для решения этой задачи TypeScript поддерживает литеральный тип. Они доступны только для типов string, boolean, number и BigInt:

type Hexlet = 'hexlet'
type One = 1
type False = false
type BigN = 100n

С точки зрения теории множеств такой тип представляет собой множество, которое состоит из одного элемента. А для системы типов это ограничение — переменной не может быть присвоено ничего, кроме указанного значения:

type TestValue = 'test'
let test: TestValue = 'test'

test = 'string' // Error: Type '"string"' is not assignable to type '"test"'.

Объединение литеральных типов

Используя объединение типов, мы можем получить тип, который принимает только нужные нам значения:

type OrderStatus = 'Created' | 'Paid' | 'Shipped' | 'Delivered'

Также литеральные типы могут комбинироваться с любыми другими типами. Так мы можем получить ограничение, под которое попадают все числа и false:

type NumberFalse = number | false

Строковые перечисления

Эта проблема в большинстве языков реализуется через перечисления, которые также добавлены в TypeScript:

enum OrderStatus {
  Created = 'Created',
  Paid = 'Paid',
  Shipped = 'Shipped',
  Delivered = 'Delivered',
}

Но в TypeScript с перечислениями не все так хорошо.

Обычно считается, что TypeScript — это надстройка над JavaScript, которая добавляет типы, не меняя сам язык. В случае с Enum, это не так. Перечисления — это конструкция языка, которая остается существовать в коде после трансляции кода в JavaScript. По этой причине некоторые разработчики используют вместо них Union Types, которые позволяют сделать практически то же самое с помощью строковых литералов.

При этом все равно рекомендуется использовать Enum в прикладном коде, потому что это дает дополнительные гарантии надежности. А в коде библиотек использовать Union Types, потому что это более гибко и дает дополнительные возможности.

Литеральные объекты

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

const dataSourceConfig = {
  type: 'postgres', // Может также быть mysql
  host: 'localhost',
  port: 5432,
}

const AppDataSource = new DataSource(dataSourceConfig)

Для описания таких объектов используется тип объектных литералов, где поля инициализируются одним литеральным типом или их объединением:

type DataSourceOption = {
  type: 'postgres' | 'mysql'
  host: string
  port: number
}

Это дает авторам библиотек дополнительный инструмент документации, а разработчикам — крутой автокомплит, который оберегает их от ошибок в передаваемых аргументах.

Приведение к литеральному типу

В случае с объектами конфигурации часто мы не хотим, чтобы их меняли извне, и ожидаем конкретных значений внутри. Здесь нам на помощь приходит приведение типа к литеральному через Type Assertion as const:

const ormConfig = {
  type: 'mysql',
  host: 'localhost',
  port: 5432,
} as const

На выходе мы получаем readonly — тип с неизменяемыми полями и литеральными типами в значении. Такая техника также применима к массивам. Она превращает их в кортежи — массивы фиксированной длины. И так же они будут защищены от изменений.