Skip to content

doc: clarify http2 docs around class exports #22247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jasnell wants to merge 1 commit into from
Closed

doc: clarify http2 docs around class exports #22247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: clarify http2 docs around class exports 
Fixes: #21434
  • Loading branch information
@jasnell
jasnell committed Aug 12, 2018
commit 12034bd13f9d91cff0ac8861b9a40f478d447eb3
13 changes: 13 additions & 0 deletions doc/api/http2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,11 @@ have occasion to work with the `Http2Session` object directly, with most
actions typically taken through interactions with either the `Http2Server` or
`Http2Stream` objects.

User code will not create `Http2Session` instances directly. Server-side
`Http2Session` instances are created by the `Http2Server` instance when a
new HTTP/2 connection is received. Client-side `Http2Session` instances are
created using the `http2.connect()` method.

#### `Http2Session` and Sockets

Every `Http2Session` instance is associated with exactly one [`net.Socket`][] or
Expand Down Expand Up @@ -1510,6 +1515,10 @@ added: v8.4.0

* Extends: {net.Server}

Instances of `Http2Server` are created using the `http2.createServer()`
function. The `Http2Server` class is not exported directly by the `http2`
module.

#### Event: 'checkContinue'
<!-- YAML
added: v8.5.0
Expand Down Expand Up @@ -1617,6 +1626,10 @@ added: v8.4.0

* Extends: {tls.Server}

Instances of `Http2SecureServer` are created using the
`http2.createSecureServer()` function. The `Http2SecureServer` class is not
exported directly by the `http2` module.

#### Event: 'checkContinue'
<!-- YAML
added: v8.5.0
Expand Down