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

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

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

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

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


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

19817В Луксоре нашли стелу с римским императором в образе фараона 19816Экипаж Artemis II о моменте, когда земля исчезла за луной 19815Почему луна выглядит по-разному в разных точках земли? 19814Adobe экстренно закрыла опасную дыру в Acrobat Reader, которую хакеры использовали с... 19813Метеорный поток, рождённый из умирающего астероида 19812Когда робот пишет за тебя прощальную смс 19811Что общего у лунной миссии, толстого попугая, загадочной плащаницы и лекарства от диабета? 19810Какие снимки Artemis II уже стали иконами лунной программы? 19809Кто на самом деле хочет сладкого — вы или ваши бактерии? 19808Как рекламные данные 500 миллионов телефонов оказались в руках спецслужб? 19807Экипаж Artemis II вернулся на землю после десяти дней в космосе 19806Зелёная и коричневая луна: почему геологи Artemis II уже не могут усидеть на месте 19805Эксперты уверены в теплозащитном щите Artemis II, несмотря на проблемы предшественника 19804Выжить внутри торнадо: каково это — когда тебя засасывает в воронку 19803Аляскинские косатки-охотники на млекопитающих замечены у берегов Сиэтла
Ссылка