Типизация объектов в Typescript: гарантия единственного обязательного поля

Для API-запросов, требующих передачи одного из нескольких параметров (например, chatId, groupId или userId), необходимо строгое ограничение на выбор только одного обязательного поля. Стандартные опциональные типы type GetUnreadMessages = { groupId?: string; chatId?: string; userId?: string; } не обеспечивают такого контроля, допуская наличие нескольких или ни одного параметра.
Типизация объектов в Typescript: гарантия единственного обязательного поля
Изображение носит иллюстративный характер

Для решения этой задачи в Typescript можно использовать утилитарный тип Record, который позволяет создавать тип с определенными ключами и значениями. Объединяя его с Partial и исключениями undefined, можно получить тип, где только один из заданных ключей является обязательным, а остальные – undefined.

Ключевым элементом является обертка RequireOnlyOne, которая перебирает все ключи исходного типа, делая каждый из них поочередно обязательным с помощью RequireOneKey. Union результатов дает возможность иметь только один обязательный ключ. Применение -? устраняет опциональность полей при переборе.

Данный подход позволяет автоматически трансформировать сгенерированные типы (например, из Swagger) для конкретных нужд, избегая ручного создания подобных структур. Это также позволяет уверенно использовать код, благодаря понятной структуре и тестам, гарантирующим корректность его работы.


Новое на сайте