expand upon js api #2641
Merged
expand upon js api #2641
+182
−5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull request overview
This PR significantly expands the JavaScript/TypeScript API documentation for Orval, transforming a minimal reference into a comprehensive programmatic usage guide. The documentation now includes detailed code examples, configuration options, watch mode details, and integration patterns for build tooling.
Key Changes:
- Added comprehensive API documentation with TypeScript examples covering basic and advanced usage patterns
- Documented the complete
GlobalOptionsinterface with detailed examples of configuration overrides - Included practical integration examples for build scripts and npm/yarn workflows
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
melloware
approved these changes
Dec 12, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The original page is just a bare note that you can import Orval and call it with a config path. The updated version expands that into a full programmatic API guide with explicit code examples, configuration options, watch mode details, overrides, and integration into build tooling.