Wejscie YAML

Wyjscie TypeScript

Czym jest konwerter YAML do TypeScript?

TypeScript uzywa interfejsow i typow do struktury. To narzedzie generuje interfejsy TypeScript z Twojego YAML, dzieki czemu mozesz typowac parsowana konfiguracje lub dane. Specyfikacja YAML 1.2 definiuje format wejsciowy.

Konwersja dziala w przegladarce. Nic nie jest wysylane na serwer. Wygenerowane typy dzialaja z parserami takimi jak js-yaml lub pakiet yaml. Dla JSON do TypeScript uzyj JSON do TypeScript.

Przyklady YAML do TypeScript

Generuj interfejsy TypeScript z YAML. Przyklad z motywem telekomunikacyjnym:

Przyklad: Rekord abonenta

Wejscie YAML

Wyjscie TypeScript:

Wyjscie TypeScript

Kliknij przycisk Przyklad powyzej, aby zaladowac wiecej przykladow do edytora.

Jak uzywac tego narzedzia

1

Wklej lub wczytaj YAML

Skopiuj swoj YAML i wklej go do lewego edytora. Mozesz tez kliknac Wczytaj, aby zaladowac plik .yaml lub .yml. Przycisk Przyklad laduje przykladowe dane. Nieprawidlowy YAML wyswietli blad.

2

Przejrzyj wyjscie TypeScript

Prawy panel pokazuje wygenerowane interfejsy TypeScript. Uzyj ich z js-yaml lub pakietem yaml do parsowania i typowania konfiguracji. Dostosuj opcjonalne pola uzywajac ? lub typow unii w razie potrzeby.

3

Kopiuj lub pobierz

Uzyj Kopiuj lub Pobierz. Dla JSON do TypeScript uzyj JSON do TypeScript. Dla formatowania YAML uzyj Formatera YAML.

Kiedy konwersja YAML do TypeScript pomaga

Przy budowaniu aplikacji Node.js lub frontendu, ktore laduja konfiguracje YAML (np. config.yml, manifesty Kubernetes lub przeplywy pracy CI), potrzebujesz typowanych struktur dla parsowanych danych. Wklej probke tutaj, a otrzymasz interfejsy TypeScript gotowe do uzycia z js-yaml lub pakietem yaml. Reczne pisanie typow dla zlozonego, zagniezdzonego YAML jest mozolne; to narzedzie wnioskuje strukture z probki.

Pliki konfiguracyjne jak application.yml lub przeplywy pracy GitHub Actions czesto maja gleboke zagniezdzenie. Wygenerowane typy pomagaja wykryc literowki i zapewniaja autouzupelnianie w IDE. Aby wyodrebnic konkretne wartosci z duzego YAML, najpierw przekonwertuj do JSON i uzyj jq.

Czesto zadawane pytania

Jak parsowac YAML w TypeScript?

Uzyj pakietu js-yaml lub yaml. Sparsuj ciag YAML i przypisz do wygenerowanego typu: const config = yaml.parse(str) as MyConfig. Do walidacji w czasie wykonania rozwaz Zod lub io-ts.

js-yaml vs pakiet yaml?

js-yaml jest szeroko stosowany. Pakiet yaml ma inne API i lepsze zachowanie komentarzy. Oba dzialaja z wygenerowanymi typami.

Czy moje dane sa prywatne?

Tak. Generowanie dziala calkowicie w przegladarce. Zadne YAML ani kod nie sa wysylane na serwer.

Pola opcjonalne vs wymagane?

Generator wnioskuje z probki. Dodaj ? do wlasciwosci interfejsu dla pol opcjonalnych. Do rygorystycznej walidacji w czasie wykonania uzyj Zod lub podobnych narzedzi z wygenerowanymi typami jako odniesieniem.

Czy dziala z Angular lub React?

Tak. Wygenerowane typy dzialaja w kazdym projekcie TypeScript. Zaladuj YAML w czasie budowania lub wykonania i rzutuj na wygenerowany typ interfejsu. Do konfiguracji srodowiska rozwaz ladowanie YAML w serwisie konfiguracyjnym.

Powiazane narzedzia

Dokumentacja TypeScript. Specyfikacja YAML. js-yaml. Specyfikacja JSON. MDN.