-
-
Notifications
You must be signed in to change notification settings - Fork 617
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(jsdoc): add JSDoc for Middleware #2680
Merged
Merged
Conversation
This file contains 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
Open
yusukebe
force-pushed
the
docs/jsdoc-middleware
branch
from
May 15, 2024 13:08
3ba7386
to
8b14488
Compare
yusukebe
force-pushed
the
docs/jsdoc-middleware
branch
from
May 15, 2024 13:13
8b14488
to
aafaa43
Compare
Hi @goisaki Great! It will be super helpful. Could you create the PR based on this jsdoc-middleware by each middleware? |
Thanks! lets add this TSDoc! 🔥 |
This was referenced May 16, 2024
@goisaki Okay! |
fix: remove unnecessary hyphens
fix: remove remove unnecessary spaces
This was referenced May 18, 2024
fix: more helpful type
feat: add missed jsdoc
feat: add missed jsdoc fix: fix type Co-authored-by: Yusuke Wada <yusuke@kamawada.com>
Co-authored-by: Yusuke Wada <yusuke@kamawada.com>
* JSX Renderer Middleware * add `[]` --------- Co-authored-by: Yusuke Wada <yusuke@kamawada.com>
* ETag Middleware * add descriptio of `options.retainedHeaders` --------- Co-authored-by: Yusuke Wada <yusuke@kamawada.com>
Hey @goisaki ! All done! I will now merge it into the |
4 tasks
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.
In this PR, let's write the JSDoc for all builtin Middleware. Only Middleware is addressed here; other documentation than Middleware is done in other PRs. Example #2677.
Will fix #1338