docs(api): add this.getOptions schema validation example#8208
Open
raj-sapalya wants to merge 1 commit intowebpack:mainfrom
Open
docs(api): add this.getOptions schema validation example#8208raj-sapalya wants to merge 1 commit intowebpack:mainfrom
raj-sapalya wants to merge 1 commit intowebpack:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What kind of change does this PR introduce?
Documentation improvement — adds a missing example for this.getOptions() with schema validation.
Summary
The this.getOptions(schema) API supports passing a JSON Schema for
automatic option validation, but the current docs show only a one-line
description with no example.
Many loader authors still use the separate schema-utils validate()
pattern because there is no example showing that this.getOptions()
handles validation natively when a schema is passed.
This PR adds a minimal working example showing:
Does this PR introduce a breaking change?
No.
What needs to be documented once your changes are merged?
Nothing additional.