diff options
| author | Ben Kelly <ben@wanderview.com> | 2012-06-06 15:05:18 -0400 |
|---|---|---|
| committer | isaacs <i@izs.me> | 2012-06-15 09:44:37 -0700 |
| commit | c6185c8484b123f552c8af8bcaec21cf3d725559 (patch) | |
| tree | ff9b05c96498d12bf365c64b95c95440a5bfe1d2 /doc/api/https.markdown | |
| parent | a111390c566c61074e4452481abf190fd955fa30 (diff) | |
| download | node-c6185c8484b123f552c8af8bcaec21cf3d725559.tar.gz | |
doc: Improve cross-linking in API docs markdown
Cross-link EventEmitter references in API docs to events.html
Fix broken cross-reference links with wrong anchor names in API docs.
Diffstat (limited to 'doc/api/https.markdown')
| -rw-r--r-- | doc/api/https.markdown | 34 |
1 files changed, 20 insertions, 14 deletions
diff --git a/doc/api/https.markdown b/doc/api/https.markdown index 10c9a3e3b..5f0052c2c 100644 --- a/doc/api/https.markdown +++ b/doc/api/https.markdown @@ -13,8 +13,8 @@ This class is a subclass of `tls.Server` and emits events same as ## https.createServer(options, [requestListener]) Returns a new HTTPS web server object. The `options` is similar to -[tls.createServer()](tls.html#tls.createServer). The `requestListener` is -a function which is automatically added to the `'request'` event. +[tls.createServer()][]. The `requestListener` is a function which is +automatically added to the `'request'` event. Example: @@ -48,8 +48,8 @@ Or ## https.request(options, callback) -Makes a request to a secure web server. -All options from [http.request()](http.html#http.request) are valid. +Makes a request to a secure web server. All options from [http.request()][] +are valid. Example: @@ -93,16 +93,15 @@ The options argument has the following options - `headers`: An object containing request headers. - `auth`: Basic authentication i.e. `'user:password'` to compute an Authorization header. -- `agent`: Controls [Agent](#https.Agent) behavior. When an Agent is - used request will default to `Connection: keep-alive`. Possible values: - - `undefined` (default): use [globalAgent](#https.globalAgent) for this - host and port. +- `agent`: Controls [Agent][] behavior. When an Agent is used request will + default to `Connection: keep-alive`. Possible values: + - `undefined` (default): use [globalAgent][] for this host and port. - `Agent` object: explicitly use the passed in `Agent`. - `false`: opts out of connection pooling with an Agent, defaults request to `Connection: close`. -The following options from [tls.connect()](tls.html#tls.connect) can also be -specified. However, a [globalAgent](#https.globalAgent) silently ignores these. +The following options from [tls.connect()][] can also be specified. However, a +[globalAgent][] silently ignores these. - `pfx`: Certificate, Private key and CA certificates to use for SSL. Default `null`. - `key`: Private key to use for SSL. Default `null`. @@ -177,11 +176,18 @@ Example: ## Class: https.Agent -An Agent object for HTTPS similar to [http.Agent](http.html#http.Agent). -See [https.request()](#https.request) for more information. +An Agent object for HTTPS similar to [http.Agent][]. See [https.request()][] +for more information. ## https.globalAgent -Global instance of [https.Agent](#https.Agent) which is used as the default -for all HTTPS client requests. +Global instance of [https.Agent][] for all HTTPS client requests. + +[Agent]: #https_class_https_agent +[globalAgent]: #https_https_globalagent +[http.Agent]: http.html#http_class_http_agent +[http.request()]: http.html#http_http_request_options_callback +[https.Agent]: #https_class_https_agent +[tls.connect()]: tls.html#tls_tls_connect_options_secureconnectlistener +[tls.createServer()]: tls.html#tls_tls_createserver_options_secureconnectionlistener |
