Этот инструмент читает значение JSON и пишет для него объявления interface на TypeScript. Ключи сохраняются в точности как есть; массивы объектов объединяются в один интерфейс, ключи, которые есть лишь в части элементов, получают ?, а смешанные значения становятся union-типами.
Используйте, чтобы типизировать ответы fetch или axios на фронтенде, объявить возвращаемые типы для API-роутов Next.js или обработчиков Express, или в любой ситуации, когда бэкенд документирует только примеры ответов без определений типов.
Имя типа (например, ChannelHistory); оно сохраняется в URL как ?name=.types.ts и используйте через import type { ChannelHistory } from "./types".{
"channel": "general",
"messages": [
{ "id": "m1", "user": "kim", "text": "deploy done", "reactions": ["+1"] },
{ "id": "m2", "user": "lee", "text": null, "edited": true, "attachment": { "type": "image", "url": "https://cdn.example.com/a.png" } }
],
"cursor": 42
}export interface ChannelHistory {
channel: string;
messages: Message[];
cursor: number;
}
export interface Message {
id: string;
user: string;
text: string | null;
reactions?: string[];
edited?: boolean;
attachment?: Attachment;
}
export interface Attachment {
type: string;
url: string;
}
Оба сообщения объединены в один интерфейс Message; reactions, edited и attachment встречаются лишь в одном из них, поэтому получают ?. text смешивает строку и null, что даёт string | null. Интерфейсы элементов получают имя ключа в единственном числе (messages → Message).
export interface, готовый к импорту в других местах."a-b", "2fa"), берутся в кавычки.?:).string | number); null добавляется последним как | null. Смешанные массивы становятся (string | number)[].unknown[].export type Root = RootItem[];.Передайте тип как дженерик, например const res = await axios.get<ChannelHistory>(url), и редактор предупредит, что res.data.messages[0].text может быть null.
Для внутренних или внешних API без SDK или пакета @types одного примера ответа достаточно, чтобы получить файл определений типов и поделиться им с командой.
Сгенерируйте интерфейсы по mock-JSON из Storybook или тестов и используйте их как типы пропсов компонентов; когда моки разойдутся с компонентами, компилятор об этом скажет.
number (без разделения на целые и дробные), а строки с датами — string."status": "active", выводятся как string; сузьте их до union литералов ("active" | "banned") сами.Profile2.type вместо интерфейсов?Псевдоним type используется только для массива или примитива верхнего уровня; объекты всегда interface. Если переписать export interface X { ... } как export type X = { ... };, для этой цели поведение будет тем же.
?) и | null разделены?Они означают разное: ? говорит, что ключа может не быть (undefined), а | null — что ключ есть, но со значением null. При включённом strictNullChecks эти два случая обрабатываются по-разному.
Тип TypeScript описывает реальный объект, так что переименованные ключи перестали бы совпадать с ответом. Если в коде нужен camelCase, определите отдельный тип для результата вашей функции маппинга.
Эта страница выдаёт только простые объявления типов. Вкладки TypeORM, Sequelize и Mongoose вверху генерируют код сущностей и моделей из того же JSON.