doc: argument types for https & argument types cleanup for http #11681

ameliavoncat · 2017-03-04T00:11:19Z

Checklist

documentation is changed or added
commit message follows commit guidelines

Affected core subsystem(s)

documentation

Description of changes

Added argument data types to the docs for the https module.
Added missing argument data types to the docs for the http module.
Lowercased primitive data types in the http module for consistency.
Changed Integer data types to Number for consistency.

Issue

joyeecheung · 2017-03-04T06:38:50Z

doc/api/https.md

+- `options` {Object | String}
+  - `method` {String} Default = `GET`
+  - `protocol` {String} Default = `http`
+  - `host` | `hostname` {String} Default = `localhost`


Maybe put them in separate entries and mention they are aliases?

joyeecheung · 2017-03-04T06:40:43Z

doc/api/http.md

@@ -110,16 +110,16 @@ added: v0.3.4

 * `options` {Object} Set of configurable options to set on the agent.
  Can have the following fields:
-  * `keepAlive` {boolean} Keep sockets around even when there are no


Er..I think lowercased primitive types are preferred after #11167?

Ahh, I had read the summary (which said the opposite) but not the comment thread. Will change.

joyeecheung · 2017-03-04T06:42:10Z

doc/api/https.md

-[`tls.createServer()`][].  The `requestListener` is a function which is
+- `options` {Object}
+  - `pfx` {String | Buffer}
+  - `key` {String | Buffer | Array[strings | buffers | objects]}


Buffer[] | string[] | Object[] are supported by the tools now..

joyeecheung · 2017-03-04T06:42:41Z

doc/api/https.md

+- `requestListener` {Function}
+
+Returns a new HTTPS web server object. The `options` are similar to
+[`tls.createServer()`][] and [`tls.createSecureContext()`][].  The `requestListener` is a function which is


nit: 80-characters wrap?

ameliavoncat · 2017-03-05T04:26:01Z

Changes made.

joyeecheung · 2017-03-05T12:57:29Z

doc/api/http.md

+  - `path` {string} Default = `/`
+  - `headers` {Object}
+  - `auth` {string}
+  - `agent` {Agent | boolean} Default = `globalAgent`


http.globalAgent would be clearer

joyeecheung · 2017-03-05T13:03:07Z

doc/api/https.md

+  - `path` {string} Default = `/`
+  - `headers` {Object}
+  - `auth` {string}
+  - `agent` {Agent | boolean} Default = `globalAgent`


https.globalAgent would be clearer(notice https.globalAgent !== http.globalAgent)

joyeecheung · 2017-03-05T13:09:02Z

doc/api/https.md

 <!-- YAML
 added: v0.3.6
 -->
+- `options` {Object | string}


Can you merge the type signatures with option explanations below? Thanks!

ameliavoncat · 2017-03-05T18:21:38Z

Updated. 😄

jasnell

Almost there!

jasnell · 2017-03-06T21:19:37Z

doc/api/http.md

@@ -1528,7 +1529,20 @@ added to the [`'request'`][] event.
 added: v0.3.6
 -->

-* `options` {Object}
+* `options` {Object | string}
+  - `protocol` {string} Defaults to `http:`.


Elsewhere in the change you using the pattern Default = ....

Would you please update for consistency? Thank you! 😄

jasnell · 2017-03-06T21:21:14Z

doc/api/https.md

+  happens at the connection level, *before* the HTTP request is sent. Default `true`.
+- `secureProtocol` {string}
+  The SSL method to use, e.g. `SSLv3_method` to force SSL version 3. The
+  possible values depend on your installation of OpenSSL and are defined in the


Please replace your with the. (in generally we avoid use of pronouns such as you and your in the docs. Thank you!

ameliavoncat · 2017-03-07T07:51:20Z

Changes made. You and your were used alot in http so I changed those as well.

joyeecheung · 2017-03-07T08:30:43Z

doc/api/http.md

@@ -1528,7 +1528,20 @@ added to the [`'request'`][] event.
 added: v0.3.6
 -->

-* `options` {Object}
+* `options` {Object | string}


Actually, I am not sure if the options need to be explained here since most of them are just passed to http.request, and that one has a more detailed explanation about these options? Maybe something like

* `options` {Object | string}: Takes the same values as `options` in [`http.request(options[, callback])`][] except that `method` is set to `GET`

is enough? This way future updates to http.request don't need to take care of the explanations here.

joyeecheung · 2017-03-07T08:36:27Z

doc/api/https.md

-Returns a new HTTPS web server object. The `options` is similar to
-[`tls.createServer()`][].  The `requestListener` is a function which is
-automatically added to the `'request'` event.
+- `options` {Object}


Same here, tls.createServer() and tls.createSecureContext() have a detailed explanation about these options, so linking to the docs of them should be enough. (Of course the signature of options itself is still necessary)

joyeecheung · 2017-03-07T08:54:09Z

doc/api/https.md

 <!-- YAML
 added: v0.3.6
 -->
+- `options` {Object | string}


Ditto for http.get

joyeecheung · 2017-03-07T08:54:46Z

doc/api/https.md

 <!-- YAML
 added: v0.3.6
 -->
+- `options` {Object | string}


Ditto for http.request, moduloagent, port, protocol differences

jasnell

LGTM once @joyeecheung is happy with it also

Refs: nodejs#9399

ameliavoncat · 2017-03-07T22:15:03Z

Updated. 😄

Refs: nodejs#9399

joyeecheung

Looking good, thanks!

joyeecheung · 2017-03-08T07:56:19Z

CI: https://ci.nodejs.org/job/node-test-pull-request/6743/

Ref: #9399 PR-URL: #11681 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

jasnell · 2017-03-08T15:43:44Z

Landed in f6b0309...9772fb9
Thank you very much @ameliavoncat !

italoacasas · 2017-03-13T15:50:54Z

This is not landing clearly in v7.x.

Ref: nodejs#9399 PR-URL: nodejs#11681 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

MylesBorins · 2017-04-17T22:40:04Z

Are the changes relevant to v6.x? italoacasas@9c3cf13 cherry picks clean.

MylesBorins · 2017-05-15T15:30:39Z

ping

jasnell · 2017-05-15T15:34:34Z

doc/api/https.md

-Returns a new HTTPS web server object. The `options` is similar to
-[`tls.createServer()`][].  The `requestListener` is a function which is
-automatically added to the `'request'` event.
+- `options` {Object} Accepts `options` from [`tls.createServer()`][] and [`tls.createSecureContext()`][].


long lines. can you please make sure to wrap all lines at <= 80 chars

HA! oops lol... totally missed that this had already landed lol :-D

gibfahn · 2017-06-17T22:55:39Z

doc/api/https.md


 Makes a request to a secure web server.

+The following additional `options` from [`tls.connect()`][] are also accepted when using a
+  custom [`Agent`][]:
+  `pfx`, `key`, `passphrase`, `cert`, `ca`, `ciphers`, `rejectUnauthorized`, `secureProtocol`, `servername`


@joyeecheung does this section apply to v6.x as well?

gibfahn · 2017-06-17T22:56:31Z

Landed on v6.x-staging, LMK if that was a mistake.

Ref: #9399 PR-URL: #11681 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Mar 4, 2017

hiroppy added the http Issues or PRs related to the http subsystem. label Mar 4, 2017

joyeecheung reviewed Mar 4, 2017

View reviewed changes

ameliavoncat force-pushed the https-data-types branch 2 times, most recently from d0bee48 to ad4ef9c Compare March 5, 2017 04:24

joyeecheung reviewed Mar 5, 2017

View reviewed changes

ameliavoncat force-pushed the https-data-types branch from ad4ef9c to a892437 Compare March 5, 2017 18:21

ameliavoncat force-pushed the https-data-types branch from a892437 to 9a2862f Compare March 5, 2017 18:25

jasnell requested changes Mar 6, 2017

View reviewed changes

ameliavoncat force-pushed the https-data-types branch from 9a2862f to bcf0909 Compare March 7, 2017 07:50

ameliavoncat force-pushed the https-data-types branch 2 times, most recently from 72af375 to a2ac3ea Compare March 7, 2017 07:58

joyeecheung reviewed Mar 7, 2017

View reviewed changes

jasnell approved these changes Mar 7, 2017

View reviewed changes

doc: argument types for https methods

a7afb96

Refs: nodejs#9399

ameliavoncat force-pushed the https-data-types branch 2 times, most recently from 5966723 to 3f63bd3 Compare March 7, 2017 22:14

doc: http cleanup and missing argument types

471bb13

Refs: nodejs#9399

ameliavoncat force-pushed the https-data-types branch from 3f63bd3 to 471bb13 Compare March 7, 2017 22:39

joyeecheung approved these changes Mar 8, 2017

View reviewed changes

jasnell pushed a commit that referenced this pull request Mar 8, 2017

doc: argument types for https methods

f6b0309

Ref: #9399 PR-URL: #11681 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

jasnell pushed a commit that referenced this pull request Mar 8, 2017

doc: http cleanup and missing argument types

9772fb9

Ref: #9399 PR-URL: #11681 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

jasnell closed this Mar 8, 2017

italoacasas pushed a commit to italoacasas/node that referenced this pull request Mar 13, 2017

doc: argument types for https methods

9c3cf13

Ref: nodejs#9399 PR-URL: nodejs#11681 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

italoacasas mentioned this pull request Mar 13, 2017

7.7.3 Release Proposal #11831

Merged

italoacasas pushed a commit to italoacasas/node that referenced this pull request Mar 14, 2017

doc: http cleanup and missing argument types

a20aa0e

Ref: nodejs#9399 PR-URL: nodejs#11681 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

jungx098 pushed a commit to jungx098/node that referenced this pull request Mar 21, 2017

doc: argument types for https methods

29bd64d

Ref: nodejs#9399 PR-URL: nodejs#11681 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

jungx098 pushed a commit to jungx098/node that referenced this pull request Mar 21, 2017

doc: http cleanup and missing argument types

91ce8fc

Ref: nodejs#9399 PR-URL: nodejs#11681 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

MylesBorins added the lts-watch-v6.x label Apr 17, 2017

jasnell reviewed May 15, 2017

View reviewed changes

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

gibfahn reviewed Jun 17, 2017

View reviewed changes

gibfahn added land-on-v6.x and removed lts-watch-v6.x labels Jun 17, 2017

gibfahn pushed a commit that referenced this pull request Jun 17, 2017

doc: argument types for https methods

beb1644

Ref: #9399 PR-URL: #11681 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

gibfahn pushed a commit that referenced this pull request Jun 20, 2017

doc: argument types for https methods

b956e32

Ref: #9399 PR-URL: #11681 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

MylesBorins added the dont-land-on-v6.x label Jun 22, 2017

MylesBorins pushed a commit that referenced this pull request Jul 11, 2017

doc: argument types for https methods

7ba172f

Ref: #9399 PR-URL: #11681 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>

MylesBorins mentioned this pull request Jul 18, 2017

v6.11.2 proposal #14356

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: argument types for https & argument types cleanup for http #11681

doc: argument types for https & argument types cleanup for http #11681

ameliavoncat commented Mar 4, 2017 •

edited

Loading

joyeecheung Mar 4, 2017

joyeecheung Mar 4, 2017

ameliavoncat Mar 4, 2017 •

edited

Loading

joyeecheung Mar 4, 2017

joyeecheung Mar 4, 2017

ameliavoncat commented Mar 5, 2017

joyeecheung Mar 5, 2017

joyeecheung Mar 5, 2017

joyeecheung Mar 5, 2017

ameliavoncat commented Mar 5, 2017

jasnell left a comment

jasnell Mar 6, 2017

jasnell Mar 6, 2017

ameliavoncat commented Mar 7, 2017

joyeecheung Mar 7, 2017

joyeecheung Mar 7, 2017

joyeecheung Mar 7, 2017

joyeecheung Mar 7, 2017

jasnell left a comment

ameliavoncat commented Mar 7, 2017

joyeecheung left a comment

joyeecheung commented Mar 8, 2017

jasnell commented Mar 8, 2017

italoacasas commented Mar 13, 2017

MylesBorins commented Apr 17, 2017

MylesBorins commented May 15, 2017

jasnell May 15, 2017

jasnell May 15, 2017

gibfahn Jun 17, 2017

gibfahn commented Jun 17, 2017

doc: argument types for https & argument types cleanup for http #11681

doc: argument types for https & argument types cleanup for http #11681

Conversation

ameliavoncat commented Mar 4, 2017 • edited Loading

Checklist

Affected core subsystem(s)

Description of changes

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ameliavoncat Mar 4, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ameliavoncat commented Mar 5, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ameliavoncat commented Mar 5, 2017

jasnell left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ameliavoncat commented Mar 7, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jasnell left a comment

Choose a reason for hiding this comment

ameliavoncat commented Mar 7, 2017

joyeecheung left a comment

Choose a reason for hiding this comment

joyeecheung commented Mar 8, 2017

jasnell commented Mar 8, 2017

italoacasas commented Mar 13, 2017

MylesBorins commented Apr 17, 2017

MylesBorins commented May 15, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gibfahn commented Jun 17, 2017

ameliavoncat commented Mar 4, 2017 •

edited

Loading

ameliavoncat Mar 4, 2017 •

edited

Loading