doc: sort https alphabetically
Reorders, with no contextual changes, the https documentation alphabetically. PR-URL: https://github.com/nodejs/node/pull/3662 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
This commit is contained in:
parent
f4c259ab94
commit
54d8bdbab9
@ -5,6 +5,11 @@
|
||||
HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a
|
||||
separate module.
|
||||
|
||||
## Class: https.Agent
|
||||
|
||||
An Agent object for HTTPS similar to [http.Agent][]. See [https.request()][]
|
||||
for more information.
|
||||
|
||||
## Class: https.Server
|
||||
|
||||
This class is a subclass of `tls.Server` and emits events same as
|
||||
@ -54,17 +59,57 @@ Or
|
||||
res.end("hello world\n");
|
||||
}).listen(8000);
|
||||
|
||||
|
||||
### server.listen(port[, host][, backlog][, callback])
|
||||
### server.listen(path[, callback])
|
||||
### server.listen(handle[, callback])
|
||||
|
||||
See [http.listen()][] for details.
|
||||
|
||||
### server.close([callback])
|
||||
|
||||
See [http.close()][] for details.
|
||||
|
||||
### server.listen(handle[, callback])
|
||||
### server.listen(path[, callback])
|
||||
### server.listen(port[, host][, backlog][, callback])
|
||||
|
||||
See [http.listen()][] for details.
|
||||
|
||||
## https.get(options, callback)
|
||||
|
||||
Like `http.get()` but for HTTPS.
|
||||
|
||||
`options` can be an object or a string. If `options` is a string, it is
|
||||
automatically parsed with [url.parse()](url.html#url_url_parse_urlstr_parsequerystring_slashesdenotehost).
|
||||
|
||||
Example:
|
||||
|
||||
var https = require('https');
|
||||
|
||||
https.get('https://encrypted.google.com/', function(res) {
|
||||
console.log("statusCode: ", res.statusCode);
|
||||
console.log("headers: ", res.headers);
|
||||
|
||||
res.on('data', function(d) {
|
||||
process.stdout.write(d);
|
||||
});
|
||||
|
||||
}).on('error', function(e) {
|
||||
console.error(e);
|
||||
});
|
||||
|
||||
## https.globalAgent
|
||||
|
||||
Global instance of [https.Agent][] for all HTTPS client requests.
|
||||
|
||||
[http.Server#setTimeout()]: http.html#http_server_settimeout_msecs_callback
|
||||
[http.Server#timeout]: http.html#http_server_timeout
|
||||
[Agent]: #https_class_https_agent
|
||||
[globalAgent]: #https_https_globalagent
|
||||
[http.listen()]: http.html#http_server_listen_port_hostname_backlog_callback
|
||||
[http.close()]: http.html#http_server_close_callback
|
||||
[http.Agent]: http.html#http_class_http_agent
|
||||
[http.request()]: http.html#http_http_request_options_callback
|
||||
[https.Agent]: #https_class_https_agent
|
||||
[https.request()]: #https_https_request_options_callback
|
||||
[tls.connect()]: tls.html#tls_tls_connect_options_callback
|
||||
[tls.createServer()]: tls.html#tls_tls_createserver_options_secureconnectionlistener
|
||||
[SSL_METHODS]: http://www.openssl.org/docs/ssl/ssl.html#DEALING_WITH_PROTOCOL_METHODS
|
||||
|
||||
## https.request(options, callback)
|
||||
|
||||
Makes a request to a secure web server.
|
||||
@ -181,51 +226,3 @@ Example:
|
||||
var req = https.request(options, function(res) {
|
||||
...
|
||||
}
|
||||
|
||||
## https.get(options, callback)
|
||||
|
||||
Like `http.get()` but for HTTPS.
|
||||
|
||||
`options` can be an object or a string. If `options` is a string, it is
|
||||
automatically parsed with [url.parse()](url.html#url_url_parse_urlstr_parsequerystring_slashesdenotehost).
|
||||
|
||||
Example:
|
||||
|
||||
var https = require('https');
|
||||
|
||||
https.get('https://encrypted.google.com/', function(res) {
|
||||
console.log("statusCode: ", res.statusCode);
|
||||
console.log("headers: ", res.headers);
|
||||
|
||||
res.on('data', function(d) {
|
||||
process.stdout.write(d);
|
||||
});
|
||||
|
||||
}).on('error', function(e) {
|
||||
console.error(e);
|
||||
});
|
||||
|
||||
|
||||
## Class: https.Agent
|
||||
|
||||
An Agent object for HTTPS similar to [http.Agent][]. See [https.request()][]
|
||||
for more information.
|
||||
|
||||
|
||||
## https.globalAgent
|
||||
|
||||
Global instance of [https.Agent][] for all HTTPS client requests.
|
||||
|
||||
[http.Server#setTimeout()]: http.html#http_server_settimeout_msecs_callback
|
||||
[http.Server#timeout]: http.html#http_server_timeout
|
||||
[Agent]: #https_class_https_agent
|
||||
[globalAgent]: #https_https_globalagent
|
||||
[http.listen()]: http.html#http_server_listen_port_hostname_backlog_callback
|
||||
[http.close()]: http.html#http_server_close_callback
|
||||
[http.Agent]: http.html#http_class_http_agent
|
||||
[http.request()]: http.html#http_http_request_options_callback
|
||||
[https.Agent]: #https_class_https_agent
|
||||
[https.request()]: #https_https_request_options_callback
|
||||
[tls.connect()]: tls.html#tls_tls_connect_options_callback
|
||||
[tls.createServer()]: tls.html#tls_tls_createserver_options_secureconnectionlistener
|
||||
[SSL_METHODS]: http://www.openssl.org/docs/ssl/ssl.html#DEALING_WITH_PROTOCOL_METHODS
|
||||
|
Loading…
x
Reference in New Issue
Block a user