diff options
author | Martin Michaelis <code@mgjm.de> | 2017-10-06 11:50:47 -0700 |
---|---|---|
committer | Ruben Bridgewater <ruben@bridgewater.de> | 2017-10-19 02:26:01 -0200 |
commit | 278f65351231f9fa034220780fba8aae940c1b9a (patch) | |
tree | 21843f8ed79456d6e6cb1d55d469487c03d2d181 /doc/api/https.md | |
parent | dc086834b14647acacfd6d1e9a20bf83df34644a (diff) | |
download | android-node-v8-278f65351231f9fa034220780fba8aae940c1b9a.tar.gz android-node-v8-278f65351231f9fa034220780fba8aae940c1b9a.tar.bz2 android-node-v8-278f65351231f9fa034220780fba8aae940c1b9a.zip |
doc: fix inconsistent server.listen documentation
The `net`, `tls`, `http` and `https` module have the same
`server.listen()` method, but have a different documenation.
Changed to a consistent link to the documentation of the `net` module.
PR-URL: https://github.com/nodejs/node/pull/16020
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc/api/https.md')
-rw-r--r-- | doc/api/https.md | 39 |
1 files changed, 15 insertions, 24 deletions
diff --git a/doc/api/https.md b/doc/api/https.md index 3ff97bf446..e8db7d16b3 100644 --- a/doc/api/https.md +++ b/doc/api/https.md @@ -23,6 +23,19 @@ added: v0.3.4 This class is a subclass of `tls.Server` and emits events same as [`http.Server`][]. See [`http.Server`][] for more information. +### server.close([callback]) +<!-- YAML +added: v0.1.90 +--> +- `callback` {Function} + +See [`server.close()`][`http.close()`] from the HTTP module for details. + +### server.listen() + +Starts the HTTPS server listening for encrypted connections. +This method is identical to [`server.listen()`][] from [`net.Server`][]. + ### server.setTimeout([msecs][, callback]) <!-- YAML added: v0.11.2 @@ -90,30 +103,6 @@ https.createServer(options, (req, res) => { }).listen(8000); ``` -### server.close([callback]) -<!-- YAML -added: v0.1.90 ---> -- `callback` {Function} - -See [`http.close()`][] for details. - -### server.listen(handle[, callback]) -- `handle` {Object} -- `callback` {Function} - -### server.listen(path[, callback]) -- `path` {string} -- `callback` {Function} - -### server.listen([port][, host][, backlog][, callback]) -- `port` {number} -- `hostname` {string} -- `backlog` {number} -- `callback` {Function} - -See [`http.listen()`][] for details. - ## https.get(options[, callback]) <!-- YAML added: v0.3.6 @@ -272,6 +261,8 @@ const req = https.request(options, (res) => { [`http.request()`]: http.html#http_http_request_options_callback [`https.Agent`]: #https_class_https_agent [`https.request()`]: #https_https_request_options_callback +[`net.Server`]: net.html#net_class_net_server +[`server.listen()`]: net.html#net_server_listen [`tls.connect()`]: tls.html#tls_tls_connect_options_callback [`tls.createSecureContext()`]: tls.html#tls_tls_createsecurecontext_options [`tls.createServer()`]: tls.html#tls_tls_createserver_options_secureconnectionlistener |