Browse Source

doc: HTTPS client's options

Fixes #1494.
koichik 13 years ago
parent
commit
e7f64a7d41
  1. 37
      doc/api/https.markdown

37
doc/api/https.markdown

@ -67,11 +67,48 @@ The options argument has the following options
- port: port of host to request to. Defaults to 443. - port: port of host to request to. Defaults to 443.
- path: Path to request. Default `'/'`. - path: Path to request. Default `'/'`.
- method: HTTP request method. Default `'GET'`. - method: HTTP request method. Default `'GET'`.
The following options can also be specified.
However, a global [Agent](http.html#http.Agent) cannot be used.
- key: Private key to use for SSL. Default `null`. - key: Private key to use for SSL. Default `null`.
- cert: Public x509 certificate to use. Default `null`. - cert: Public x509 certificate to use. Default `null`.
- ca: An authority certificate or array of authority certificates to check - ca: An authority certificate or array of authority certificates to check
the remote host against. the remote host against.
In order to specify these options, use a custom `Agent`.
Example:
var options = {
host: 'encrypted.google.com',
port: 443,
path: '/',
method: 'GET',
key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
};
options.agent = new https.Agent(options);
var req = https.request(options, function(res) {
...
}
Or does not use an `Agent`.
Example:
var options = {
host: 'encrypted.google.com',
port: 443,
path: '/',
method: 'GET',
key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
agent: false
};
var req = https.request(options, function(res) {
...
}
## https.get(options, callback) ## https.get(options, callback)

Loading…
Cancel
Save