orval-labs/orval

Docs: throwOnError option needs documentation in the official docs

Geschlossen

#3.364 geöffnet am 16.05.2026

Auf GitHub ansehenContributor Guide
 (4 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (648 Forks)auto 404
documentationgood first issue

Repository-Metriken

Stars
 (6.272 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 2T 15h) (73 gemergte PRs in 30 T)

Beschreibung

Describe the issue

The throwOnError option was recently added to GlobalOptions for the generate() function. This option changes error handling behavior but is not yet documented in the official orval documentation website.

Suggested improvement

Document the throwOnError option in:

  1. The API reference for generate()
  2. The configuration options page
  3. Any relevant guides about programmatic usage

Include a code example showing how to use it for custom error handling.

Contributor Guide

Research-Richtung
Tech Stack
Domain
Issue Type
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Voraussetzungen
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.