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

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

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

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

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


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

19857Острова как политический побег: от Атлантиды до плавучих государств Питера Тиля 19856Яйца, которые спасли предков млекопитающих от худшего апокалипсиса на Земле? 19855Могут ли омары чувствовать боль, и почему учёные требуют запретить варить их живыми? 19854Премия в $3 млн за первое CRISPR-лечение серповидноклеточной анемии 19853Почему сотрудники игнорируют корпоративное обучение и как это исправить 19852Тинтагель: место силы Артура или красивая легенда? 19851Голоса в голове сказали правду: что происходит, когда галлюцинации ставят диагноз точнее... 19850Куда исчезает информация из чёрных дыр, если они вообще исчезают? 19849Чёрная дыра лебедь Х-1 бросает джеты со скоростью света — но кто ими управляет? 19848Что увидели фотографы над замком Линдисфарн — и почему они закричали? 19847Почему антисептики в больницах могут создавать устойчивых к ним микробов? 19846Правда ли, что курица может жить без головы? 19845Как Оскар Уайльд использовал причёску как оружие против викторианской морали? 19844Назальный спрей против всех вирусов: как далеко зашла наука 19843«Я ещё не осознал, что мы только что сделали»: первая пресс-конференция экипажа Artemis II
Ссылка