expressjs/expressjs.com

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

Open

#1.151 aberto em 15 de mai. de 2020

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)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.

Guia do colaborador

Pilha de tecnologia
nodejsjavascript
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Express.js basicsJSDoc knowledge
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80
Direção de pesquisa
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.