expressjs/expressjs.com

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

Open

Aperta il 15 mag 2020

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)CSS (5330 star) (2088 fork)batch import
enhancementhelp wanted

Descrizione

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.

Guida contributor

Tech stack
nodejsjavascript
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Express.js basicsJSDoc knowledge
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80
Direzione di ricerca
The issue requests adding documentation for the router function `router(req, res, [next])` in the Express API docs (http://expressjs.com/en/4x/api.html#router). Examine the existing API doc structure and the 4x and 5x versions to determine where to add the new documentation. There are no linked pull requests, so this is a fresh documentation addition.