JSON na TypeScript
Zamień przykładowy JSON na interfejsy lub aliasy typów TypeScript. Zagnieżdżone obiekty stają się osobnymi nazwanymi typami, tablice obiektów są łączone, dzięki czemu klucze nieobecne w niektórych elementach stają się opcjonalne, a wartości różnych typów tworzą typy unii. Wklej odpowiedź API, wybierz interfejs lub typ i skopiuj deklaracje, które możesz od razu wkleić do swojego kodu.
Najczęściej zadawane pytania
Jak obsługiwane są zagnieżdżone obiekty?
Każdy zagnieżdżony obiekt otrzymuje własną deklarację, nazwaną na podstawie klucza, pod którym występuje, w zapisie PascalCase; na przykład address staje się Address. Obiekty w tablicach są nazywane na podstawie liczby pojedynczej klucza tablicy, więc users staje się User, a categories — Category. Obiekty z dokładnie tymi samymi polami współdzielą jedną deklarację.
Kiedy właściwość staje się opcjonalna?
Gdy tablica zawiera kilka obiektów, a w niektórych z nich brakuje klucza, ten klucz jest oznaczany jako opcjonalny znakiem zapytania. Klucze występujące w każdym elemencie pozostają wymagane. Pojedynczego obiektu nie można porównać z innymi przykładami, więc wszystkie jego klucze są wymagane.
Jak typowane są wartości null?
Klucz, którego wartością w przykładzie jest null, jest typowany jako null, a klucz, którego wartością w części elementów jest null, a w pozostałych ciąg znaków, staje się string | null. Jeśli w rzeczywistych danych pole może mieć wartość null, ale w przykładzie nigdy jej nie ma, dodaj null ręcznie albo wklej przykład, który ją zawiera.
Czy wybrać interface czy type?
Oba opisują ten sam kształt danych. Interfejsy można rozszerzać i scalać, co wiele przewodników po stylu kodu zaleca dla kształtów obiektów; aliasy typów obsługują też unie i są używane przez niektóre zespoły do wszystkiego. Wybierz rozwiązanie stosowane w swojej bazie kodu — pola będą identyczne.
Jak typowane są tablice?
Tablica zawierająca jeden rodzaj wartości staje się tablicą tego typu, zapisaną z [] na końcu, na przykład string[] lub User[]. Tablica z kilkoma rodzajami wartości staje się unią ujętą w nawiasy, na przykład (string | number)[]. Pusta tablica staje się unknown[], ponieważ przykład nie zawiera informacji o jej elementach.
Co dzieje się z kluczami, które nie są prawidłowymi identyfikatorami?
Klucze zawierające spacje, myślniki lub inne niedozwolone znaki w identyfikatorze TypeScript są zapisywane w cudzysłowie, na przykład "first-name": string. Jest to prawidłowy zapis TypeScript i dokładnie odpowiada JSON.
Czy liczby są typowane jako integer czy float?
TypeScript ma jeden typ liczbowy, więc zarówno liczby całkowite, jak i dziesiętne stają się typem number. Jeśli chcesz rozróżniać wartości całkowite, JSON Schema Generator odróżnia integer od number.
Czy mogę zmienić nazwę typu głównego?
Tak. Wpisz nazwę typu głównego, na przykład ApiResponse. Zostanie ona przekształcona do zapisu PascalCase, a nazwy typów zagnieżdżonych nadal będą pochodzić od ich kluczy. Jeśli najwyższy poziom Twojego JSON jest tablicą lub pojedynczą wartością, typ główny staje się dla niej aliasem typu.
Czy wykrywane są daty?
Nie. JSON nie ma typu daty, więc data w przykładzie jest ciągiem znaków i jest typowana jako string. Po przetworzeniu zamień ją w swoim kodzie na Date albo ręcznie zawęź typ, jeśli używasz typu literału szablonowego.
Jak duży może być JSON?
Maksymalnie 1,000,000 znaków i do 64 poziomów zagnieżdżenia. Przykład jest analizowany wyłącznie w celu wygenerowania typów i nie jest przechowywany.