Skip to content

docs: fix JSDoc for req.accepts() return value and parameter format #6936

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.

Sign up for GitHub

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

Merged
bjohansebas merged 6 commits into from
Jan 16, 2026
+4 −8
Merged

docs: fix JSDoc for req.accepts() return value and parameter format #6936

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
73eb99d
fixed request accept jsdoc
marcosmol204 Dec 2, 2025
bd424ff
reverted format
marcosmol204 Dec 2, 2025
863245a
Merge branch 'update-request-accepts-js-doc' of https://github.com/ma…
marcosmol204 Dec 2, 2025
fd0e9d4
reverted format
marcosmol204 Dec 2, 2025
2d0884f
updated jsdoc
marcosmol204 Dec 2, 2025
17489f6
updated the rest of the documentation
marcosmol204 Jan 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions lib/request.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,16 +83,13 @@ req.header = function header(name) {
};

/**
* To do: update docs.
*
* Check if the given `type(s)` is acceptable, returning
* the best match when true, otherwise `undefined`, in which
* the best match when true, otherwise `false`, in which
* case you should respond with 406 "Not Acceptable".
*
* The `type` value may be a single MIME type string
* such as "application/json", an extension name
* such as "json", a comma-delimited list such as "json, html, text/plain",
* an argument list such as `"json", "html", "text/plain"`,
* such as "json", an argument list such as `"json", "html", "text/plain"`,
* or an array `["json", "html", "text/plain"]`. When a list
* or array is given, the _best_ match, if any is returned.
*
Expand Down Expand Up @@ -120,7 +117,6 @@ req.header = function header(name) {
* // Accept: text/*;q=.5, application/json
* req.accepts(['html', 'json']);
* req.accepts('html', 'json');
* req.accepts('html, json');
* // => "json"
*
* @param {String|Array} type(s)
Expand Down