expressjs/expressjs.com

Add API docs for router(req, res, [next])

Open

#1,151 opened on May 15, 2020

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)CSS (2,088 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (5,330 stars)
PR merge metrics
 (Avg merge 13d 7h) (43 merged PRs in 30d)

Description

The instance function router(req, res, [next]) I can't find documented in the API docs. We should get it listed there and documented, somewhere in the http://expressjs.com/en/4x/api.html#router section.

The same docs would be in the 4x and 5x API docs.

Contributor guide

Research direction
Find the appropriate location in the API docs file (likely in the router section) and add a description for `router(req, res, [next])` with examples.
Tech stack
javascript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80