docs(ip-restriction): add clear JSDoc examples and param types#4851
Merged
yusukebe merged 1 commit intohonojs:mainfrom Apr 1, 2026
Merged
docs(ip-restriction): add clear JSDoc examples and param types#4851yusukebe merged 1 commit intohonojs:mainfrom
yusukebe merged 1 commit intohonojs:mainfrom
Conversation
Contributor
Author
|
Hi @yusukebe, could you please review and merge this when you have time? Thank you. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4851 +/- ##
=======================================
Coverage 92.84% 92.85%
=======================================
Files 177 177
Lines 11643 11657 +14
Branches 3469 3475 +6
=======================================
+ Hits 10810 10824 +14
Misses 832 832
Partials 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Member
|
@VISHNU7KASIREDDY Thanks! |
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.
This PR adds a comprehensive
@exampleblock and fully documents the@paramand@returnstags for theipRestrictionmiddleware. This will help developers understand how to correctly configure itsallowList/denyListand customonErrorhandler right from their IDE.@paramdocumentation@exampleshowcasing complex CIDR/IP combinations and a custom error handler@seelinking directly to the Hono ip-restriction docsAddresses the current lack of IDE context for this specific middleware.