JSON naar TypeScript
Zet een JSON-voorbeeld om in TypeScript-interfaces of type-aliases. Geneste objecten krijgen een eigen benoemd type, arrays met objecten worden samengevoegd zodat sleutels die in sommige items ontbreken optioneel worden, en gemengde waarden worden union-types. Plak een API-response, kies interface of type en kopieer declaraties die u direct in uw code kunt gebruiken.
Veelgestelde vragen
Hoe worden geneste objecten verwerkt?
Elk genest object krijgt een eigen declaratie, genoemd naar de sleutel die het bevat in PascalCase; address wordt bijvoorbeeld Address. Objecten in arrays worden genoemd naar het enkelvoud van de arraysleutel, dus users wordt User en categories wordt Category. Objecten met precies dezelfde velden delen één declaratie.
Wanneer wordt een eigenschap optioneel?
Als een array meerdere objecten bevat en een sleutel in sommige daarvan ontbreekt, wordt die sleutel met een vraagteken als optioneel gemarkeerd. Sleutels die in elk item voorkomen, blijven verplicht. Bij één object zijn er geen andere voorbeelden om mee te vergelijken, dus zijn alle sleutels verplicht.
Hoe worden null-waarden getypeerd?
Een sleutel die in uw voorbeeld null is, wordt getypeerd als null. Een sleutel die in sommige items null is en in andere een string, wordt string | null. Als een veld in echte gegevens null kan zijn maar in uw voorbeeld nooit null is, voeg null dan handmatig toe of plak een voorbeeld waarin het voorkomt.
Moet ik interface of type kiezen?
Beide beschrijven dezelfde structuur. Interfaces kunnen worden uitgebreid en samengevoegd, wat veel stijlgidsen voor objectstructuren aanbevelen; type-aliases werken ook voor unions en sommige teams gebruiken ze overal. Kies wat uw codebase gebruikt; de velden zijn identiek.
Hoe worden arrays getypeerd?
Een array met één soort waarde wordt dat type met [] erachter, zoals string[] of User[]. Een array met meerdere soorten wordt een union tussen haakjes, zoals (string | number)[]. Een lege array wordt unknown[], omdat het voorbeeld niets zegt over de items.
Wat gebeurt er met sleutels die geen geldige identifiers zijn?
Sleutels met spaties, streepjes of andere tekens die niet zijn toegestaan in een TypeScript-identifier, worden tussen aanhalingstekens gezet. Bijvoorbeeld "first-name": string; dat is geldige TypeScript en komt exact overeen met de JSON.
Worden getallen als integer of float getypeerd?
TypeScript heeft één getaltype, dus zowel gehele getallen als decimalen worden number. Als u wilt weten welke waarden gehele getallen zijn, maakt de JSON Schema Generator onderscheid tussen integer en number.
Kan ik het root-type een andere naam geven?
Ja. Voer een naam in voor het root-type, zoals ApiResponse. Deze wordt omgezet naar PascalCase; de geneste types behouden de namen die van hun sleutels zijn afgeleid. Als het hoogste niveau van uw JSON een array of één waarde is, wordt het root-type daarvoor een type-alias.
Worden datums herkend?
Nee. JSON heeft geen datumtype, dus een datum in uw voorbeeld is een string en wordt getypeerd als string. Zet deze na het parsen in uw code om naar een Date, of beperk het type handmatig als u een template-literaltype gebruikt.
Hoe groot mag de JSON zijn?
Maximaal 1,000,000 tekens, met een nestingdiepte van maximaal 64 niveaus. Het voorbeeld wordt alleen geanalyseerd om de types te genereren en wordt niet opgeslagen.