expressjs/expressjs.com

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

Open

#1 151 ouverte le 15 mai 2020

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)CSS (5 330 stars) (2 088 forks)batch import
enhancementhelp wanted

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.

Guide contributeur

Stack technique
nodejsjavascript
Domaine
documentation
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Express.js basicsJSDoc knowledge
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80
Direction de recherche
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.