orval-labs/orval

Docs: throwOnError option needs documentation in the official docs

Open

#3,364 opened on May 16, 2026

View on GitHub
 (4 comments) (0 reactions) (0 assignees)TypeScript (648 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (6,272 stars)
PR merge metrics
 (PR metrics pending)

Description

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 direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.