Document options for https.request
authorRyan Dahl <ry@tinyclouds.org>
Thu, 10 Mar 2011 21:34:35 +0000 (13:34 -0800)
committerRyan Dahl <ry@tinyclouds.org>
Thu, 10 Mar 2011 21:34:50 +0000 (13:34 -0800)
Closes GH-768.

doc/api/https.markdown

index b98c16b..3c6a7c4 100644 (file)
@@ -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.