Repository navigation
Documentation for Http2ServerRequest properties #23825
Description
Activity
@nodejs/documentation @nodejs/http2
Looks like
methodandurlare documented. Still needsauthorityandscheme. I don't see nay reason these shouldn't be documented.@kenigbolo I think the documentation of
Http2ServerRequest.methodis a good example. And the source of the documentation is atdoc/api/http2.md.And the contributing guide for PRs is a good starting point. But for a "documentation only" PR there is no need to compile and test node itself. It should be enough to test the documentation with
make test-doc(instead of a full./configure && make -j4 test).And if
make test-docfails with "Could not find executable. Should be out/Release/node" you can link to your global node as a temporary fix:
mkdir out/Release && ln -s `which node` out/Release/nodeReacted by Rich Trott and Kenigbolo Meya Stephen- added a commit that references this issue
on Jan 14, 2019 - added a commit that references this issue
on Feb 12, 2019 - added a commit that references this issue
on Feb 20, 2019 - added a commit that references this issue
on Feb 28, 2019 - added a commit that references this issue
on Jul 27, 2026
Is your feature request related to a problem? Please describe.
The
http2.Http2ServerRequesthas some useful properties that are undocumented. But IMHO, they should be part of the public API.Describe the solution you'd like
The following properties could become part of the
http2module documentation:method,authority,scheme,url(See
lib/internal/http2/compat.js)Describe alternatives you've considered
The alternative is to use the headers object:
PR?
If these properties should be documented and therefore part of the public API, I am happy to create the corresponding documentation in a PR.