Skip to content
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 19 commits into from
May 24, 2024
Merged

docs(jsdoc): add JSDoc for Middleware #2680

merged 19 commits into from
May 24, 2024

Conversation

yusukebe
Copy link
Member

@yusukebe yusukebe commented May 15, 2024

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


@yusukebe yusukebe marked this pull request as draft May 15, 2024 12:51
@yusukebe yusukebe mentioned this pull request May 15, 2024
@yusukebe yusukebe force-pushed the docs/jsdoc-middleware branch from 3ba7386 to 8b14488 Compare May 15, 2024 13:08
@yusukebe yusukebe force-pushed the docs/jsdoc-middleware branch from 8b14488 to aafaa43 Compare May 15, 2024 13:13
@yusukebe
Copy link
Member Author

Hi @goisaki

Great! It will be super helpful.

Could you create the PR based on this jsdoc-middleware by each middleware?

@fzn0x
Copy link
Contributor

fzn0x commented May 15, 2024

Thanks! lets add this TSDoc! 🔥

@goisaki
Copy link
Contributor

goisaki commented May 18, 2024

@yusukebe

BOO!
Check these out.
Hono Pull 2680

@yusukebe
Copy link
Member Author

@goisaki Okay!

@yusukebe yusukebe added the v4.4 label May 21, 2024
goisaki and others added 3 commits May 21, 2024 22:11
Co-authored-by: Yusuke Wada <yusuke@kamawada.com>
* JSX Renderer Middleware

* add `[]`

---------

Co-authored-by: Yusuke Wada <yusuke@kamawada.com>
@yusukebe yusukebe changed the base branch from main to next May 22, 2024 20:37
* ETag Middleware

* add descriptio of `options.retainedHeaders`

---------

Co-authored-by: Yusuke Wada <yusuke@kamawada.com>
@yusukebe yusukebe marked this pull request as ready for review May 24, 2024 08:17
@yusukebe
Copy link
Member Author

Hey @goisaki !

All done! I will now merge it into the next. I will leave the commit without squash. Thank you very much!

@yusukebe yusukebe merged commit 3fb4aef into next May 24, 2024
10 checks passed
@yusukebe yusukebe deleted the docs/jsdoc-middleware branch May 24, 2024 08:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

JSDoc
3 participants