JSON na Zod
Generuj schematy Zod na podstawie przykładowych danych JSON. Zagnieżdżone obiekty stają się osobnymi eksportowanymi schematami, klucze brakujące w części elementów tablicy otrzymują .optional(), wartości null otrzymują .nullable(), a wartości różnych typów stają się z.union. Każdy schemat otrzymuje też alias typu z.infer, dzięki czemu jedno wklejenie zapewnia walidację w czasie działania i typy TypeScript.
Najczęściej zadawane pytania
Jak nazywane są zagnieżdżone obiekty?
Każdy zagnieżdżony obiekt staje się osobnym typem Zod, nazwanym według klucza, pod którym występuje, w PascalCase, więc address zmienia się w Address. Obiekty w tablicach przyjmują liczbę pojedynczą klucza tablicy, więc users zmienia się w User. Obiekty o dokładnie tych samych polach współdzielą jeden typ.
Kiedy pole jest opcjonalne?
Gdy tablica zawiera kilka obiektów, a w części z nich brakuje klucza, pole jest opcjonalne: schemat dodaje .optional(). Klucz obecny w każdym przykładzie jest wymagany. Pojedynczego obiektu nie można z niczym porównać, więc wszystkie jego klucze są wymagane.
Jak obsługiwane są wartości null?
Klucz, który w części przykładów ma wartość null, a w pozostałych ma inną wartość, staje się typem z .nullable(). Klucz, który zawsze ma wartość null, nie dostarcza narzędziu informacji o swoim rzeczywistym typie, więc staje się z.null(); wklej przykład z rzeczywistą wartością, aby uzyskać precyzyjny typ.
Jakie typy liczb są używane?
Liczby całkowite stają się z.number().int(), a liczby z częścią ułamkową — z.number(). Gdy to samo pole zawiera oba rodzaje, schemat używa z.number(), ponieważ każda liczba całkowita jest też prawidłową liczbą.
Co dzieje się z kluczami, które nie są prawidłowymi nazwami?
Klucze, które nie są prawidłowymi identyfikatorami JavaScript, takimi jak first-name, są zapisywane w cudzysłowach w z.object, dzięki czemu schemat nadal dokładnie odpowiada oryginalnym kluczom JSON.
Czy moje JSON jest przesyłane lub przechowywane?
JSON jest wysyłane na serwer tylko w celu wygenerowania kodu dla tego żądania i nie jest przechowywane. Generator odczytuje jedynie strukturę i typy wartości przykładowych danych, więc przed wklejeniem możesz zastąpić wrażliwe wartości symbolami zastępczymi tego samego typu.