Skip to content

Documentation Enhancement Request – Add "Example" Column/Tab for All The Properties #2364

@Rajeevkumar69

Description

@Rajeevkumar69

Description

Hello Express Team,

I would like to suggest a small documentation enhancement for pages such as express.Router([options]).

Currently, the documentation shows the property name, description, default value, and availability. While this explains what a property does, it does not show how to use it in practice.

For options like mergeParams, caseSensitive, and strict, I often need to leave the documentation and search Google or Stack Overflow for implementation examples.

A possible improvement would be to add either:

  • An Example column beside each property, or

  • An Example tab containing:

    • Example code
    • Common use cases
    • Expected behavior/output

Example:

const router = express.Router({
  mergeParams: true
});

This would make the documentation more practical, reduce external searches, and help developers understand features more quickly.

Thank you for considering this suggestion and for maintaining Express.

Best regards

Image

Expectations

Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions