Skip to content

Wrong v9.4.0 documentation for ServerHttp2Stream#pushStream() #18198

Closed
@jinwoo

Description

@jinwoo
  • Version: v9.4.0
  • Platform: Darwin Kernel Version 17.3.0: Thu Nov 9 18:09:22 PST 2017; root:xnu-4570.31.3~1/RELEASE_X86_64 x86_64
  • Subsystem: http2

#17406 changed the callback function of ServerHttp2Stream#pushStream() from (pushedStream, headers) => {} to (err, pushedStream, headers) => {}. But the example code in the documentation still says the former: https://nodejs.org/dist/latest-v9.x/docs/api/http2.html#http2_http2stream_pushstream_headers_options_callback

It'd be great if the example code could be updated. Even better would be to document the callback function's signature in more detail. The document says just Function, which is not very helpful.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to the documentations.good first issueIssues that are suitable for first-time contributors.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions