Skip to content

docs: fix req.query JSDoc return type - #7526

Open
NUAAwqy wants to merge 1 commit into
expressjs:masterfrom
NUAAwqy:fix/query-jsdoc-return-type
Open

NUAAwqy wants to merge 1 commit into
expressjs:masterfrom
NUAAwqy:fix/query-jsdoc-return-type

Conversation

@NUAAwqy

@NUAAwqy NUAAwqy commented Oct 17, 2026

Copy link
Copy Markdown

The JSDoc block above the query getter in lib/request.js says @return {String}, but the getter returns the parsed query object. This changes the tag to @return {Object}. I verified by reading the getter: it calls the configured query parser and returns its object result.

Fixes #7525

AI-assisted; verified manually.

Signed-off-by: NUAAwqy <146524024+NUAAwqy@users.noreply.github.com>

@subhiandrews subhiandrews left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

code-check review

No issues found.

Incomplete: no usable output from skeptic; this review is not approved.

Reviewed with code-check · Apache-2.0

@subhiandrews subhiandrews left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

code-check review

No issues found.

Incomplete: no usable output from pragmatist; this review is not approved.

Reviewed with code-check · Apache-2.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

JSDoc for the req.query getter documents the wrong return type

2 participants