From: Ryan Dahl <ry@tinyclouds.org>
Date: Thu, 10 Mar 2011 21:34:35 +0000 (-0800)
Subject: Document options for https.request
X-Git-Tag: v0.4.3~25
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=9a8e843ca3a6f381fb69d9a760f36ea9458d290b;p=platform%2Fupstream%2Fnodejs.git

Document options for https.request

Closes GH-768.
---

diff --git a/doc/api/https.markdown b/doc/api/https.markdown
index b98c16b..3c6a7c4 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.