JSDoc for the req.query getter documents the wrong return type · Issue #7525 · expressjs/express · GitHub
Skip to content

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

Open

Description

@NUAAwqy

In lib/request.js, the JSDoc block above the query getter says @return {String}, but the getter parses the query string with the configured query parser and returns an object. Since the 5.x API reference is generated from these comments, the docs page shows the wrong type. It should be @return {Object}.

Activity

  1. krzysdz commented on Oct 17, 2026

    @krzysdz
    Contributor

    Since the 5.x API reference is generated from these comments, the docs page shows the wrong type.

    Which Express docs page and API reference is generated from JSDoc comments? Is this sentence just written by an LLM and was it not checked by a human?

    The official website expressjs.com does not generate anything from JSDoc and it shows Object as the type of req.query.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions