Binabasa ng tool na ito ang isang JSON value at isinusulat ang mga TypeScript interface declaration para dito. Eksaktong napapanatili ang mga key; pinagsasama sa iisang interface ang mga array ng object, nakakakuha ng ? ang mga key na nasa ilang item lang, at nagiging union type ang mga halo-halong value.
Gamitin ito para lagyan ng type ang mga fetch o axios response sa frontend, para mag-declare ng mga return type para sa mga Next.js API route o Express handler, o tuwing mga halimbawang response lang ang idinodokumento ng isang backend at walang type definition.
Pangalan ng type ang pangalan ng root interface (hal. ChannelHistory); nananatili ito sa URL bilang ?name=.types.ts at gamitin ito sa pamamagitan ng 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;
}
Pinagsasama sa iisang Message interface ang dalawang message; nasa isa lang sa kanila ang reactions, edited at attachment, kaya nakakakuha sila ng ?. Halo ang string at null sa text, kaya string | null ito. Kinukuha ng mga element interface ang singular na anyo ng key (messages → Message).
export interface ang bawat declaration, handang i-import sa ibang lugar."a-b", "2fa").?:) ang mga key na wala sa ilang element.string | number) ang mga halo-halong type; idinudugtong sa huli ang null bilang | null. Nagiging (string | number)[] ang mga halo-halong array.unknown[] sila.export type Root = RootItem[];.Ipasa ang type bilang generic, hal. const res = await axios.get<ChannelHistory>(url), at babalaan ka ng editor na puwedeng null ang res.data.messages[0].text.
Para sa mga internal o external na API na walang SDK o @types package, sapat na ang isang sample response para gumawa ng type definition file na maibabahagi sa team.
Gumawa ng mga interface mula sa Storybook o test mock JSON at gamitin sila bilang props type ng mga component; kapag lumayo ang mga mock sa mga component, sasabihan ka ng compiler.
number ang lahat ng numero (walang hiwalay na integer/float), at string ang mga date string.string ang mga field na may fixed na set ng value, gaya ng "status": "active"; ikaw na ang magpaliit sa kanila bilang literal union ("active" | "banned").Profile2 ang mga nagbabanggaang pangalan.type alias sa halip na interface?Para lang sa top-level na array o primitive ginagamit ang type alias; laging interface ang mga object. Pareho ang behavior para sa layuning ito kapag isinulat ulit ang export interface X { ... } bilang export type X = { ... };.
?) at | null?Magkaiba ang ibig sabihin nila: sinasabi ng ? na puwedeng wala ang key (undefined), habang sinasabi ng | null na nandoon ang key pero null ang value. Kapag naka-on ang strictNullChecks, magkaiba ang paghawak mo sa dalawang kaso.
Inilalarawan ng isang TypeScript type ang totoong object, kaya hindi na tutugma sa response ang mga key na pinalitan ng pangalan. Kung gusto mo ng camelCase sa code mo, mag-define ng hiwalay na type para sa resulta ng mapping function mo.
Mga simpleng type declaration lang ang inilalabas ng page na ito. Gumagawa ng entity at model code mula sa parehong JSON ang mga tab na TypeORM, Sequelize at Mongoose sa itaas.