From 9a8e843ca3a6f381fb69d9a760f36ea9458d290b Mon Sep 17 00:00:00 2001 From: Ryan Dahl Date: Thu, 10 Mar 2011 13:34:35 -0800 Subject: [PATCH] Document options for https.request Closes GH-768. --- doc/api/https.markdown | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/doc/api/https.markdown b/doc/api/https.markdown index b98c16b1f0..3c6a7c43a0 100644 --- a/doc/api/https.markdown +++ b/doc/api/https.markdown @@ -53,6 +53,18 @@ Example: console.error(e); }); +The options argument has the following options + +- host: IP or domain of host to make request to. Defaults to `'localhost'`. +- port: port of host to request to. Defaults to 443. +- path: Path to request. Default `'/'`. +- method: HTTP request method. Default `'GET'`. +- key: Private key to use for SSL. Default `null`. +- cert: Public x509 certificate to use. Default `null`. +- ca: An authority certificate or array of authority certificates to check + the remote host against. + + ## https.get(options, callback) Like `http.get()` but for HTTPS.