Uh oh!
There was an error while loading. Please reload this page.
feat: add Signature and Param components for API method documentation - #2389
Merged
Conversation
✅ Deploy Preview for expressjscom-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…documentation clarity
…ic, express.text, and express.urlencoded documentation with detailed parameter descriptions
…lude options parameter with detailed descriptions
- Added detailed signatures and parameter descriptions for various app methods including app.all, app.delete, app.enable, app.disabled, app.engine, app.get, app.listen, app.METHOD, app.param, app.post, app.put, app.render, app.route, app.set, and app.use. - Introduced <Signature> and <Param> components for better clarity and structure in documentation. - Updated references and links for consistency and accuracy. - Included examples and explanations for middleware functions and routing methods.
- Corrected links in the application API documentation for `res.render` and `res.render()` method. - Updated response object documentation to reflect changes in method signatures and descriptions, including `res.download`, `res.end`, `res.json`, `res.jsonp`, `res.redirect`, `res.render`, `res.send`, `res.sendFile`, and `res.sendStatus`. - Improved clarity and consistency in the routing guide for both 4.x and 5.x versions by updating method references to match the new documentation structure.
Uh oh!
There was an error while loading. Please reload this page.
bjohansebas pushed a commit
that referenced
this pull request
Jun 22, 2026
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 freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Express v3 wasn’t modified because we really shouldn’t spend time polishing something that is no longer used. Otherwise, I fixed the documentation and other parts here that were somewhat outdated.