JSON в TypeScript
Преобразуйте пример JSON в интерфейсы или псевдонимы типов TypeScript. Вложенные объекты становятся отдельными именованными типами, массивы объектов объединяются, чтобы отсутствующие в некоторых элементах ключи становились необязательными, а значения разных типов превращаются в объединённые типы. Вставьте ответ API, выберите интерфейс или тип и скопируйте объявления, которые можно сразу добавить в код.
Часто задаваемые вопросы
Как обрабатываются вложенные объекты?
Для каждого вложенного объекта создаётся отдельное объявление с именем ключа, в котором он содержится, в PascalCase: например, address становится Address. Объекты внутри массивов получают имена по единственному числу ключа массива: users становится User, а categories — Category. Для объектов с полностью одинаковыми полями используется одно объявление.
Когда свойство становится необязательным?
Если в массиве несколько объектов и в некоторых из них отсутствует ключ, он помечается как необязательный с помощью вопросительного знака. Ключи, встречающиеся в каждом элементе, остаются обязательными. Для одного объекта нет других примеров для сравнения, поэтому все его ключи обязательны.
Как типизируются значения null?
Если в примере значению ключа соответствует null, его типом будет null; если в одних элементах ключу соответствует null, а в других — строка, его типом будет string | null. Если в реальных данных поле может иметь значение null, но в примере оно не встречается, добавьте null вручную или вставьте пример с таким значением.
Что выбрать: интерфейс или тип?
Оба варианта описывают одну и ту же структуру. Интерфейсы можно расширять и объединять, поэтому многие руководства по стилю рекомендуют их для описания структур объектов. Псевдонимы типов также подходят для объединённых типов и используются некоторыми командами повсеместно. Выбирайте вариант, принятый в вашей кодовой базе: поля будут одинаковыми.
Как типизируются массивы?
Массив значений одного типа преобразуется в этот тип с добавлением [] после него, например string[] или User[]. Массив значений разных типов становится объединением в скобках, например (string | number)[]. Пустой массив преобразуется в unknown[], потому что в примере нет информации о его элементах.
Что происходит с ключами, которые не являются допустимыми идентификаторами?
Ключи с пробелами, дефисами и другими недопустимыми символами в идентификаторе TypeScript заключаются в кавычки. Например, "first-name": string — допустимая запись TypeScript, точно соответствующая JSON.
Числа типизируются как целые или дробные?
В TypeScript есть один числовой тип, поэтому целые и дробные числа преобразуются в number. Если нужно различать целые числа и остальные, воспользуйтесь генератором схем JSON, который различает integer и number.
Можно ли переименовать корневой тип?
Да. Введите имя корневого типа, например ApiResponse. Оно преобразуется в PascalCase, а имена вложенных типов будут сформированы из соответствующих ключей. Если верхний уровень JSON — это массив или отдельное значение, корневой тип становится псевдонимом этого типа.
Распознаются ли даты?
Нет. В JSON нет типа даты, поэтому дата в примере считается строкой и получает тип string. Преобразуйте её в Date в коде после разбора или вручную сузьте тип, если используете шаблонный строковый тип.
Каков максимальный размер JSON?
До 1,000,000 символов и глубина вложенности до 64 уровней. Пример анализируется только для создания типов и не сохраняется.