Chinedu Francis Nwafili
0cb0287f8a
doc: fix buf.length slice example
...
Previously tried to reassign a const.
PR-URL: https://github.com/nodejs/node/pull/5259
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Trevor Norris <trev.norris@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-02-18 03:17:44 +01:00
Chinedu Francis Nwafili
069072c4bf
doc: fix buffer[index] example
...
PR-URL: https://github.com/nodejs/node/pull/5253
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-02-18 03:06:18 +01:00
Rafael Cepeda
51bd77022b
doc: fix template string
...
Template string was syntactically incorrect. Copied Documentation code
would throw an error.
PR-URL: https://github.com/nodejs/node/pull/5240
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-02-18 03:01:47 +01:00
Noah Rose
c605c5d587
doc: clarify exceptions during uncaughtException
...
PR-URL: https://github.com/nodejs/node/pull/5180
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com >
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Benjamin Gruenbaum <inglor@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-02-17 23:56:02 +01:00
Alexander Makarenko
fb502ef081
doc: improvements to console.markdown copy
...
Fix missing links. Fix styling of printf() - once #5073 lands,
link to man page will be auto-generated. Fix several typos.
PR-URL: https://github.com/nodejs/node/pull/5225
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-17 23:51:30 +01:00
cjihrig
7550160e2b
doc: update process.send() signature
...
This commit brings the process.send() signature into sync with
the child_process.send() documentation. Specifically, this commit
adds the callback argument and return type to the docs.
PR-URL: https://github.com/nodejs/node/pull/5284
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-17 12:18:24 -05:00
James M Snell
9b6440a86c
doc: add simple http clientError example
...
The clientError event allows proper http 4xx responses to
be returned when a parse error occurs, but the documentation
did not demonstrate how to use it.
PR-URL: https://github.com/nodejs/node/pull/5248
Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com >
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com >
2016-02-17 08:31:19 -08:00
Brian White
a1dace166a
doc: fix net.createConnection() example
...
PR-URL: https://github.com/nodejs/node/pull/5219
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-15 07:40:27 -08:00
Brian White
9bee03aaf2
http: allow async createConnection()
...
This commit adds support for async createConnection()
implementations and is still backwards compatible with
synchronous createConnection() implementations.
This commit also makes the http client more friendly with
generic stream objects produced by createConnection() by
checking stream.writable instead of stream.destroyed as the
latter is currently a net.Socket-ism and not set by the core
stream implementations.
PR-URL: https://github.com/nodejs/node/pull/4638
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-11 12:52:46 -05:00
Rich Trott
49fa0abf9b
doc: fix minor inconsistencies in repl doc
...
PR-URL: https://github.com/nodejs/node/pull/5193
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-11 07:16:28 -08:00
Trevor Norris
b55e58042c
buffer: add encoding parameter to fill()
...
Can now call fill() using following parameters if value is a String:
fill(string[, start[, end]][, encoding])
And with the following if value is a Buffer:
fill(buffer[, start[, end]])
The encoding is ignored if value is not a String. All other non-Buffer
values are coerced to a uint32.
A multibyte strings will simply be copied into the Buffer until the
number of bytes run out. Meaning partial strings can be left behind:
Buffer(3).fill('\u0222');
// returns: <Buffer c8 a2 c8>
In some encoding cases, such as 'hex', fill() will throw if the input
string is not valid.
PR-URL: https://github.com/nodejs/node/pull/4935
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-10 12:06:20 -07:00
James M Snell
7bef1b7907
http: strictly forbid invalid characters from headers
...
PR-URL: https://github.com/nodejs/node-private/pull/26
Reviewed-By: Rod Vagg <r@va.gg >
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2016-02-09 09:22:09 -08:00
Alejandro Oviedo
3da7d13e59
doc: merging behavior of writeHead vs setHeader
...
PR-URL: https://github.com/nodejs/node/pull/5081
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-02-09 13:17:38 +01:00
Claudio Rodriguez
47e926a8d6
doc: fix type references for link gen, link css
...
Fixes several type references in the docs so that the
doc html gen tool that parses them can put the correct
links in.
Changes css styling for the generated type links.
PR-URL: https://github.com/nodejs/node/pull/4741
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Chris Dickinson <chris@neversaw.us >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-02-09 13:12:21 +01:00
Rich Trott
394556e9f5
doc: fix dgram doc indentation
...
PR-URL: https://github.com/nodejs/node/pull/5118
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-02-08 13:25:23 -08:00
Daniel Turing
dbdbdd4998
dns: add resolvePtr to query plain DNS PTR records
...
Resolving plain PTR records is used beyond reverse DNS, most
prominently with DNS-SD (RFC6763). This adds dns.resolvePtr(),
and uses it (instead of dns.reverse()) in dns.resolve().
PR-URL: https://github.com/nodejs/node/pull/4921
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: Brian White <mscdex@mscdex.net >
2016-02-08 17:30:38 +01:00
Matteo Collina
76bc4c75bf
doc: clarify dgram socket.send() multi-buffer support
...
Fixes : #5124
See: https://github.com/nodejs/node/pull/4374
PR-URL: https://github.com/nodejs/node/pull/5130
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-08 16:15:34 +00:00
Ben Noordhuis
eaa9e0e776
doc: console is asynchronous unless it's a file
...
Mea culpa, looks like I forgot to update console.markdown in commit
dac1d38 ("doc: stdout/stderr can block when directed to file").
This commit rectifies that.
Refs: https://github.com/nodejs/node/issues/5131
PR-URL: https://github.com/nodejs/node/pull/5133
Reviewed-By: Brian White <mscdex@mscdex.net >
Reviewed-By: Evan Lucas <evanlucas@me.com >
2016-02-07 23:28:21 +01:00
Rich Trott
07424705a6
doc: fix typo in dgram doc
...
Remove stray square brackets from dgram documentation.
PR-URL: https://github.com/nodejs/node/pull/5114
Reviewed-By: Brian White <mscdex@mscdex.net >
Reviewed By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
2016-02-07 08:16:59 -08:00
Alexander Makarenko
c714b2e21c
doc: fix links order in Buffer doc
...
Sort links in lexical order
PR-URL: https://github.com/nodejs/node/pull/5076
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Roman Klauke <romaaan.git@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-04 10:53:24 -08:00
Alexander Makarenko
39d0797449
doc: minor improvement in OS docs
...
Add links to `process.arch` and `process.platform`.
PR-URL: https://github.com/nodejs/node/pull/5006
Reviewed-By: Roman Klauke <romaaan.git@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-02-04 19:25:07 +01:00
Alexander Makarenko
13a3685e43
doc: fix links in Addons docs
...
Put links in a lexical order. Add missing links. Remove duplicates.
PR-URL: https://github.com/nodejs/node/pull/5072
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-04 10:14:46 -08:00
Brian White
01dd8ed113
doc: fix inconsistent styling
...
PR-URL: https://github.com/nodejs/node/pull/4996
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-04 10:11:07 -08:00
Timothy Gu
ac0d92e4d1
doc: fix link in cluster documentation
...
PR-URL: https://github.com/nodejs/node/pull/5068
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Brian White <mscdex@mscdex.net >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-04 10:00:10 -08:00
Minwoo Jung
34a5019b6b
doc: fix reference to API hash.final
...
fix a reference to a non-existent API, `hash.final()`.
It should be `hash.digest()`.
PR-URL: https://github.com/nodejs/node/pull/5050
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
2016-02-04 22:15:30 +09:00
Brian White
c41c09375b
doc: correct tlsSocket.getCipher() description
...
getCipher() actually includes the protocol version that the cipher was
first supported and *not* the negotiated protocol of the current
connection.
PR-URL: https://github.com/nodejs/node/pull/4995
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-03 21:36:40 -05:00
Brian White
2c357a7e3b
tls: add getProtocol() to TLS sockets
...
This commit adds a new method for TLS sockets that returns the
negotiated protocol version.
PR-URL: https://github.com/nodejs/node/pull/4995
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-03 21:34:06 -05:00
Michaël Zasso
4501a28ad9
doc: clarify optional arguments of Buffer methods
...
PR-URL: https://github.com/nodejs/node/pull/5008
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com >
2016-02-03 19:54:50 +01:00
Rainer Oviir
977159f149
doc: uppercase 'RSA-SHA256' in crypto.markdown
...
Fixes: https://github.com/nodejs/node/issues/5031
PR-URL: https://github.com/nodejs/node/pull/5044
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Brian White <mscdex@mscdex.net >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-03 01:10:58 +01:00
Rich Trott
3874f32277
doc: apply consistent styling for functions
...
Always refer to (for example) `assert.deepEqual()` as
`assert.deepEqual()` and never as `assert.deepEqual`.
PR-URL: https://github.com/nodejs/node/pull/4974
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com >
2016-02-02 14:28:49 -08:00
Alexander Makarenko
b0b4aeb640
doc: multiple improvements in Stream docs
...
Add missing links, remove duplicate ones, fix constants and functions styling.
Minor lexical corrections.
PR-URL: https://github.com/nodejs/node/pull/5009
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com >
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-02 09:53:37 -08:00
Alexander Makarenko
0c924ea39f
doc: improve styling consistency in VM docs
...
Improve functions styling. Connect sections with links.
PR-URL: https://github.com/nodejs/node/pull/5005
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-02 09:03:10 -08:00
piepmatz
d74eb5fe01
doc: fix anchor links from stream to http and events
...
PR-URL: https://github.com/nodejs/node/pull/5007
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-02 09:01:23 -08:00
Evan Lucas
f3be421c1c
dns: coerce port to number in lookupService
...
Previously, port could be any number in dns.lookupService. This change
throws a TypeError if port is outside the range of 0-65535. It also
coerces the port to a number.
PR-URL: https://github.com/nodejs/node/pull/4883
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Brian White <mscdex@mscdex.net >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-01 09:36:57 -08:00
Alexander Makarenko
4736eeca53
doc: minor improvement to HTTPS doc
...
Add link to Buffer page.
PR-URL: https://github.com/nodejs/node/pull/5002
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Chris Dickinson <chris@neversaw.us >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-01 09:14:42 -08:00
Alexander Makarenko
7aff1d95b7
doc: improve styling consistency in Buffer docs
...
Add links style consistency.
PR-URL: https://github.com/nodejs/node/pull/5001
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
Reviewed-By: Roman Klauke <romaaan.git@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-01 09:11:26 -08:00
Alexander Makarenko
267bb391ec
doc: consistent styling for functions in TLS docs
...
Provide links for functions where needed and fix function links style.
PR-URL: https://github.com/nodejs/node/pull/5000
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Roman Klauke <romaaan.git@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-02-01 09:09:52 -08:00
Prayag Verma
4644673f2d
doc: fix minor typo in process doc
...
Remove extra `be`
PR-URL: https://github.com/nodejs/node/pull/5018
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com >
Reviewed-By: Michaël Zasso <mic.besace@gmail.com >
2016-02-01 08:48:02 +01:00
Minwoo Jung
de3e94b0ef
doc: fix notDeepEqual API
...
API calls in `assert` are `deepEqual()`, not `notDeepEqual()`.
use `notDeepEqual` to make it clear.
PR-URL: https://github.com/nodejs/node/pull/4971
Reviewed-By: Rich Trott <rtrott@gmail.com >
2016-01-31 16:49:52 +09:00
Timothy Gu
6ad1f7b51c
doc: make buffer methods styles consistent
...
- Maintain alphabetical order
- Add documentation for `offset` and `value` where absent
- Add return value documentation where absent
- Remove redundant "Optional"
- Move defaults to parameter enumerations
PR-URL: https://github.com/nodejs/node/pull/4873
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-01-30 11:22:11 -08:00
Timothy Gu
27c8b73fa6
doc: fix JSON generation for aliased methods
...
Currently assert/assert.ok currently has the following signature:
"signatures": [
{
"params": [
{
"name": "value"
},
{
"name": "message])"
},
{
"name": "assert.ok(value"
},
{
"name": "message",
"optional": true
}
]
}
]
The heading reads
assert(value[, message]), assert.ok(value[, message])
Split them into two sections to make it working.
PR-URL: https://github.com/nodejs/node/pull/4871
Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com >
2016-01-30 11:06:25 -08:00
Evan Lucas
8ff9b56c92
doc: add more details to process.env
...
process.env has a few quirks that deserve documenting.
The commit documents:
- How assigning to process.env will implicitly call `toString()`
- How to remove an environment variable from process.env
PR-URL: https://github.com/nodejs/node/pull/4924
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-01-29 22:09:08 -06:00
ChALkeR
6894c62df5
doc: don't use "interface" as a variable name
...
In readline.markdown, don't use strict mode reserved keyword "interface"
as a variable name.
This commit changes the name of one `readline.Interface` instance from
"interface" to "rl", as it is named in other places of the doc.
PR-URL: https://github.com/nodejs/node/pull/4900
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-01-30 00:33:14 +01:00
Peter Lyons
b004bbd9bd
doc: spell writable consistently
...
Docs have 108 instances of "writable" and only 1 "writeable" so
fix this one.
PR-URL: https://github.com/nodejs/node/pull/4954
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-01-30 00:22:42 +01:00
Matteo Collina
137f53c7b7
dgram: support dgram.send with multiple buffers
...
Added ability to dgram.send to send multiple buffers, _writev style.
The offset and length parameters in dgram.send are now optional.
Refactored the dgram benchmarks, and seperated them from net.
Added docs for the new signature.
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Saúl Ibarra Corretgé <saghul@gmail.com >
Fixes: https://github.com/nodejs/node/issues/4302
PR-URL: https://github.com/nodejs/node/pull/4374
2016-01-29 19:26:44 +01:00
Kári Tristan Helgason
3218dfbe60
doc: update eol handling in readline
...
This commit explicitly calls out the end of line sequences
used to generate line events in the readline module.
Fixes: https://github.com/nodejs/node/issues/4916
PR-URL: https://github.com/nodejs/node/pull/4927
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2016-01-28 10:08:33 -05:00
Benjamin Gruenbaum
334a7e3614
doc: replace function expressions with arrows
...
This commit replaces multiple usages of `function(){}` with ES2015
arrow functions in places it was forgotten earlier. The goal is to
make the docs more consistent since other functions were already
replaced with ES2015 arrows.
In addition, it fixes invalid syntax in modules.markdown to valid
syntax as well as remove `var self = this` pattern usages in the code
where they are now possible to avoid through arrow functions.
PR-URL: https://github.com/nodejs/node/pull/4832
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-01-27 23:00:20 +01:00
Sakthipriyan Vairamani
4714abb482
doc: show links consistently in deprecations
...
PR-URL: https://github.com/nodejs/node/pull/4907
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-01-27 13:42:45 -08:00
cjihrig
c3bb4b1aa5
child_process: add shell option to spawn()
...
This commit adds a shell option, to spawn() and spawnSync(). This
option allows child processes to be spawned with or without a
shell. The option also allows a custom shell to be defined, for
compatibility with exec()'s shell option.
Fixes: https://github.com/nodejs/node/issues/1009
PR-URL: https://github.com/nodejs/node/pull/4598
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: James M Snell <jasnell@gmail.com >
2016-01-26 19:40:43 -05:00
Dmitriy Lazarev
2c426355df
doc: remove unnecessary bind(this)
...
PR-URL: https://github.com/nodejs/node/pull/4797
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Chris Dickinson <chris@neversaw.us >
Reviewed-By: Roman Reiss <me@silverwind.io >
2016-01-26 20:49:13 +01:00