docs: improve Ajv instance README guidance - #127
Merged
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
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.
Summary
validator.ajvmust be configured before callingvalidate()ajv-formatsexample for schemas usingformat: "email"Closes #113
Note
Low Risk
Documentation-only updates; no runtime code changes, with minimal risk beyond potentially confusing guidance if incorrect.
Overview
Updates
README.mdto clarify Ajv configuration order: create aValidator, configurevalidator.ajv(formats/plugins/custom keywords), then callvalidate()so schemas compile with the configured Ajv instance.Refreshes examples to instantiate
validatorexplicitly (instead of destructuring fromnew Validator()), adds a concreteajv-formats/format: "email"walkthrough, and adjusts the v2→v3 migration note and Ajv option link to point readers at the new guidance.Written by Cursor Bugbot for commit 8fd070f. This will update automatically on new commits. Configure here.