JSON do TypeScript
Převeďte ukázku JSON na rozhraní nebo aliasy typů TypeScript. Vnořené objekty se převedou na vlastní pojmenované typy, pole objektů se sloučí, takže klíče chybějící v některých položkách budou nepovinné, a z kombinovaných hodnot vzniknou sjednocené typy. Vložte odpověď API, vyberte rozhraní nebo typ a zkopírujte deklarace, které můžete rovnou vložit do kódu.
Často kladené otázky
Jak se zpracovávají vnořené objekty?
Každý vnořený objekt dostane vlastní deklaraci pojmenovanou podle klíče, který ho obsahuje, v PascalCase; například z address vznikne Address. Objekty v polích se pojmenovávají podle jednotného čísla klíče pole, takže z users vznikne User a z categories Category. Objekty se zcela shodnými poli sdílejí jednu deklaraci.
Kdy se vlastnost označí jako nepovinná?
Pokud pole obsahuje několik objektů a některé z nich určitý klíč postrádají, označí se tento klíč jako nepovinný otazníkem. Klíče, které se vyskytují ve všech položkách, zůstávají povinné. U jediného objektu není žádný další vzorek k porovnání, takže všechny jeho klíče jsou povinné.
Jak se typují hodnoty null?
Klíč, jehož hodnotou je ve vašem vzorku null, se typuje jako null. Pokud je u některých položek hodnota klíče null a u jiných řetězec, vznikne typ string | null. Pokud může být pole ve skutečných datech null, ale ve vašem vzorku se taková hodnota nevyskytuje, přidejte null ručně nebo vložte vzorek, který ji obsahuje.
Mám zvolit interface, nebo type?
Obě možnosti popisují stejný tvar. Rozhraní lze rozšiřovat a slučovat, což mnohé příručky stylu kódu doporučují pro tvary objektů; aliasy typů fungují také pro sjednocené typy a některé týmy je používají všude. Zvolte možnost, kterou používá vaše kódová základna; pole jsou totožná.
Jak se typují pole?
Pole s jedním druhem hodnot se převede na daný typ s [] za ním, například string[] nebo User[]. Pole s několika druhy hodnot se převede na sjednocený typ v závorkách, například (string | number)[]. Prázdné pole se převede na unknown[], protože vzorek o jeho položkách nic neříká.
Co se stane s klíči, které nejsou platnými identifikátory?
Klíče obsahující mezery, pomlčky nebo jiné nepovolené znaky v identifikátoru TypeScript se zapisují do uvozovek, například "first-name": string. To je platné TypeScript a přesně odpovídá JSON.
Typují se čísla jako celá čísla, nebo desetinná?
TypeScript má jeden číselný typ, takže celá i desetinná čísla se převedou na number. Pokud potřebujete zjistit, které hodnoty jsou celá čísla, JSON Schema Generator rozlišuje integer a number.
Mohu přejmenovat kořenový typ?
Ano. Zadejte název kořenového typu, například ApiResponse. Převede se do PascalCase a vnořené typy si ponechají názvy odvozené od svých klíčů. Pokud je nejvyšší úroveň vašeho JSON pole nebo jediná hodnota, kořen se převede na alias typu.
Rozpoznávají se data?
Ne. JSON nemá typ pro datum, takže datum ve vzorku je řetězec a typuje se jako string. Po parsování jej v kódu převeďte na Date, nebo typ ručně zúžte, pokud používáte typ šablonového řetězce.
Jak velké může být JSON?
Až 1,000,000 znaků a do hloubky 64 vnořených úrovní. Vzorek se pouze analyzuje pro vytvoření typů a neukládá se.