Commit Graph
1940 Commits
Author SHA1 Message Date
Anna Henningsen 010ac70892 doc: fix broken refs to url.parse() in http docs
PR-URL: https://github.com/nodejs/node/pull/7392
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-29 04:07:28 +02:00
Anna Henningsen e8356b25cd doc: add added: information for https
Ref: https://github.com/nodejs/node/issues/6578
PR-URL: https://github.com/nodejs/node/pull/7392
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-29 04:07:25 +02:00
Anna Henningsen 72500f942b doc: add added: information for http
Ref: https://github.com/nodejs/node/issues/6578
PR-URL: https://github.com/nodejs/node/pull/7392
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-29 04:06:57 +02:00
James M Snell 86e07b7c24 doc: general improvements to timers.md
Overall improvements to timers.md documentation,

Includes squashed commit from @bengl:

  doc: add timer classes

  The timers returned by `setTimeout` and friends are
  actually instances of `Timeout` and `Immediate`.
  Documenting them as such, so that the `ref` and
  `unref` methods can be identified as methods on
  `Timeout` objects.

  Sparked by discussion in #5792

PR-URL: https://github.com/nodejs/node/pull/6937
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: Bryan English <bryan@bryanenglish.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2016-06-28 07:39:31 -07:00
Zach Bjornson a1059afd39 buffer: speed up swap16/32, add swap64
* Speed up buffer.swap16 and swap32 by using builtins. Up to ~6x gain.
  Drop transition point between JS and C++ implementations accordingly.
  Amount of performance improvement not only depends on buffer size but
  also memory alignment.
* Fix tests: C++ impl tests were testing 0-filled buffers so were
  always passing.
* Add similar buffer.swap64 method.
* Make buffer-swap benchmark mirror JS impl.

doc/api/buffer.markdown has an entry of "added: REPLACEME" that should
be changed to the correct release number before tagged.

Because node is currently using a very old version of cpplint.py it
doesn't know that std::swap() has moved from <algorithm> to <utility> in
c++11. So until cpplint.py is updated simply NOLINT the line.
Technically it should be NOLINT(build/include_what_you_use), but that
puts the line over 80 characters causing another lint error.

PR-URL: https://github.com/nodejs/node/pull/7157
Reviewed-By: Trevor Norris <trev.norris@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-27 14:38:37 -06:00
Rich Trott 4220e86414 doc: fix typographic error in process doc
An apostrophe was being used where a backtick was called for, resulting
in improper rendering.

PR-URL: https://github.com/nodejs/node/pull/7431
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Ingvar Stepanyan <me@rreverser.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-27 08:52:49 -07:00
Ruslan Iusupov 97dc38e8fc doc: fix "sign.verify" typo in crypto doc.
Fix typo in example

PR-URL: https://github.com/nodejs/node/pull/7411
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-27 08:43:35 -07:00
sartrey 926707f0a7 doc: clarify child_process stdout/stderr types
Clarify how the encoding option interacts with the data
type of child process stdout and stderr.

Fixes: https://github.com/nodejs/node/issues/6666
PR-URL: https://github.com/nodejs/node/pull/7361
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2016-06-27 09:43:01 -04:00
Evan Lucas 3f5623dd46 readline: allow passing prompt to constructor
Previously, one would have to call setPrompt after calling
rl.createInterface. Now, the prompt string can be set by passing the
prompt property.

PR-URL: https://github.com/nodejs/node/pull/7125
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2016-06-25 12:10:28 -05:00
Italo A. Casas 79f961aa09 doc: fix link in the stream doc
fixing typo
fixing broken links

PR-URL: https://github.com/nodejs/node/pull/7347
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
2016-06-23 22:14:03 +02:00
akki f3114e2a3e doc: fix repl defineCommand example
Fixes: https://github.com/nodejs/node/issues/7357
PR-URL: https://github.com/nodejs/node/pull/7365
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-23 13:48:59 -04:00
Italo A. Casas c2e6078ed9 doc: add added: information for tls
Ref: https://github.com/nodejs/node/issues/6578
PR-URL: https://github.com/nodejs/node/pull/7018
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-06-23 02:01:29 +02:00
Kyle E. Mitchell 86fdbe0c25 doc: mention http request "aborted" events
Fixes: https://github.com/nodejs/node/issues/6925
PR-URL: https://github.com/nodejs/node/pull/7270
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-06-23 01:30:34 +02:00
Rich Trott 92adbe4793 doc: add argument information for socket.destroy()
PR-URL: https://github.com/nodejs/node/pull/7238
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>
Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
2016-06-21 21:07:18 -07:00
James M Snell ecc48a154d doc: general improvements to os.md copy
PR-URL: https://github.com/nodejs/node/pull/7124
Reviewed-By: Brian White <mscdex@mscdex.net>
2016-06-21 11:17:05 -07:00
vsemozhetbyt 58a241d537 doc: fix typos in the stream doc
PR-URL: https://github.com/nodejs/node/pull/7336
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-21 18:57:43 +02:00
Tushar Mathur 193afef3b0 doc: document socket.destroyed
Fixes: https://github.com/nodejs/node/issues/5898
PR-URL: https://github.com/nodejs/node/pull/6128
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2016-06-21 11:09:38 -04:00
Richard Lau a06ccdbdb5 doc: correct added: information for fs.access
fs.access and fs.accessSync were added to Node v0.11.15 via 2944934

PR-URL: https://github.com/nodejs/node/pull/7299
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Ref: https://github.com/nodejs/node/pull/6717
Ref: https://github.com/nodejs/node/issues/6578
2016-06-18 21:15:52 +02:00
Anna Henningsen 740d8cf5e0 doc: add added: information for repl
Ref: https://github.com/nodejs/node/issues/6578
PR-URL: https://github.com/nodejs/node/pull/7256
Reviewed-By: Julian Duque <julianduquej@gmail.com>
2016-06-18 20:49:54 +02:00
Anna Henningsen 6a93ab11a9 repl: break on sigint/ctrl+c
Adds the ability to stop execution of the current REPL command
when receiving SIGINT. This applies only to the default eval
function.

Fixes: https://github.com/nodejs/node/issues/6612
PR-URL: https://github.com/nodejs/node/pull/6635
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2016-06-18 20:44:25 +02:00
Anna Henningsen 0815b9401d vm: add ability to break on sigint/ctrl+c
- Adds the `breakEvalOnSigint` option to `vm.runIn(This)Context`.
  This uses a watchdog thread to wait for SIGINT and generally works
  just like the existing `timeout` option.

- Adds a method to the existing timer-based watchdog to check if it
  stopped regularly or by running into the timeout. This is used to
  tell a SIGINT abort from a timer-based one.

- Adds (internal) `process._{start,stop}SigintWatchdog` methods to
  start/stop the watchdog thread used by the above option manually.
  This will be used in the REPL to set up SIGINT handling before
  entering terminal raw mode, so that there is no time window in
  which Ctrl+C fully aborts the process.

PR-URL: https://github.com/nodejs/node/pull/6635
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2016-06-18 20:44:16 +02:00
Luigi Pinca de9a84186e doc: fix broken link in vm.md
PR-URL: https://github.com/nodejs/node/pull/7304
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
2016-06-17 22:25:30 +02:00
cjihrig 62c8e7b922 doc: fix cluster worker 'message' event
This commit adds the missing handle argument to the cluster
worker 'message' event. It also adds a link to the process
'message' event for reference.

Refs: https://github.com/nodejs/node/pull/7297
PR-URL: https://github.com/nodejs/node/pull/7309
Reviewed-By: Brian White <mscdex@mscdex.net>
2016-06-17 14:55:08 -04:00
Greyson Parrelli 62a858c60f doc: fix events typo
This commit removes an extraneous word.

PR-URL: https://github.com/nodejs/node/pull/7329
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
2016-06-17 13:25:28 -04:00
kimown d06820c624 doc: use Buffer.byteLength for Content-Length
As the description in http.md:

> If the body contains higher coded characters then
Buffer.byteLength() should be used to determine the number of
bytes in a given encoding.

PR-URL: https://github.com/nodejs/node/pull/7274
Reviewed-By: Brian White <mscdex@mscdex.net>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jackson Tian <shyvo1987@gmail.com>
2016-06-12 23:17:45 +08:00
Rich Trott 4f2aec307e doc: add information for IncomingMessage.destroy()
Add documentation for `http.IncomingMessage.prototype.destroy()`.

PR-URL: https://github.com/nodejs/node/pull/7237
Fixes: https://github.com/nodejs/node/issues/4226
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: cjihrig - Colin Ihrig <cjihrig@gmail.com>
2016-06-11 20:11:31 -07:00
James M Snell 197a465280 zlib: move constants into zlib.constants
zlib constants were previously being added to binding in node_zlib.cc.
This moves the zlib constants to node_constants.cc for consistency with
the recent constants refactoring:
  https://github.com/nodejs/node/pull/6534

Adds require('zlib').constants to expose the constants
Docs-only deprecates the constants hung directly off require('zlib')
Removes a couple constants from the docs that apparently no longer
exist in the code

PR-URL: https://github.com/nodejs/node/pull/7203
Reviewed-By: Rod Vagg <rod@vagg.org>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2016-06-11 17:24:35 -07:00
James M Snell a173483619 doc: general improvements to path.md copy
PR-URL: https://github.com/nodejs/node/pull/7122
Reviewed-By: Brian White <mscdex@mscdex.net>
2016-06-11 17:20:57 -07:00
Rich Trott f2c59d9658 doc: url.format() parameter may be a string
PR-URL: https://github.com/nodejs/node/pull/7235
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: cjihrig - Colin Ihrig <cjihrig@gmail.com>
2016-06-10 21:45:02 -07:00
Rich Trott 60891c6ef0 doc: clarify use of 0 port value
Clarify that using a port value of `0` will result in the operating
system identifying an available port for use.

PR-URL: https://github.com/nodejs/node/pull/7206
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: cjihrig - Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-06-09 22:20:50 -07:00
Jesús Leganés Combarro "piranna 0cd0118334 stream: 'data' argument on callback of Transform._flush()
Add a `data` argument on Transform._flush() callback to be API
consistent with Transform._transform().

Fixes: https://github.com/nodejs/node/issues/3707
PR-URL: https://github.com/nodejs/node/pull/3708
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2016-06-09 11:06:01 +02:00
cjihrig 779091ffdb doc: remove cluster.setupMaster() myth
cluster.setupMaster() can be called more than once. Core even has
tests for this functionality. This commit removes an incorrect
statement to the contrary from the documentation.

Fixes: https://github.com/nodejs/node/issues/7156
PR-URL: https://github.com/nodejs/node/pull/7179
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com>
2016-06-08 11:50:32 -04:00
James M Snell d9e0d8b810 doc: fix minor nit introduced in readline.md
PR-URL: https://github.com/nodejs/node/pull/7198
Reviewed-By: Julian Duque <julianduquej@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-06-07 18:55:32 -04:00
Trevor Norris e0b8dd59bc src: remove final trace of raw encoding
A message stuck around in the native API warning users to not use 'raw'
encoding. Followed by an abort(). This is no longer necessary since all
other signs of 'raw' encoding have been removed.

PR-URL: https://github.com/nodejs/node/pull/7111
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-07 13:54:24 -06:00
Trevor Norris 54cc7212df buffer: introduce latin1 encoding term
When node began using the OneByte API (f150d56) it also switched to
officially supporting ISO-8859-1. Though at the time no new encoding
string was introduced.

Introduce the new encoding string 'latin1' to be more explicit. The
previous 'binary' and documented as an alias to 'latin1'.  While many
tests have switched to use 'latin1', there are still plenty that do both
'binary' and 'latin1' checks side-by-side to ensure there is no
regression.

PR-URL: https://github.com/nodejs/node/pull/7111
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-07 13:51:14 -06:00
James M Snell c300ba2212 doc: clarify rl.question callback args
Clarify that readline's rl.question() callback does not
use the err back pattern.

Fixes: https://github.com/nodejs/node/issues/4833
PR-URL: https://github.com/nodejs/node/pull/7022
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2016-06-07 07:15:14 -07:00
James M Snell ed8b600b98 doc: general improvements to readline.md copy
PR-URL: https://github.com/nodejs/node/pull/7022
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2016-06-07 07:15:09 -07:00
Rich Trott a78c2335b1 doc: use consistent typography in streams.md
In prose, always surround `null`-as-a-value in backticks.

PR-URL: https://github.com/nodejs/node/pull/6986
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
2016-06-06 17:06:58 -07:00
James M Snell a32f7eb4be doc: general improvements to process.md copy
PR-URL: https://github.com/nodejs/node/pull/7029
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2016-06-06 14:53:10 -07:00
James M Snell c339c58c4f doc: general improvements to repl.md copy
The repl documentation has always been rather lacking. This is
a first step towards making significant improvements.

PR-URL: https://github.com/nodejs/node/pull/7002
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-06-06 14:49:06 -07:00
Julian Duque 0ed4d8c535 doc: add added: information for readline
Got the information from git history, I added the version when Interface
was exported as class (v0.1.104), it was an internal class on previous
versions.

Refs: https://github.com/nodejs/node/issues/6578
PR-URL: https://github.com/nodejs/node/pull/6996
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-06 09:11:14 -07:00
Jonathan Montane c3e86de9ba doc: improved syntax consistency in console.md
`stdout` was written as `inline code` most of the time,
except for the `console.time` and `console.timeEnd`
functions which made it a bit more tedious to read about.
Now it's always using inline code.

PR-URL: https://github.com/nodejs/node/pull/7062
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Robert Jefe Lindstaedt <robert.lindstaedt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-06 09:07:33 -07:00
Lance Ball d976d66cfc doc: clarify fs.access works on directories too.
This is maybe more verbose than needed, since the same information is
repeated several times. An alternative, maybe a single short sentence at
the beginning is better. E.g.

Fixes: https://github.com/nodejs/node/issues/7110
PR-URL: https://github.com/nodejs/node/pull/7113
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-06 08:46:08 -07:00
James M Snell 80f1fbb00f doc: general improvements to querystring.md copy
PR-URL: https://github.com/nodejs/node/pull/7023
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Brian White <mscdex@mscdex.net>
2016-06-06 08:35:19 -07:00
James M Snell 267556762d doc: fix header depth of util.isSymbol
PR-URL: https://github.com/nodejs/node/pull/7138
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-06-06 08:19:03 -07:00
James M Snell 80ea0c5a64 doc: general improvements to stream.md copy
Majoring restructuring and update for streams doc.
This is the first step of multiple to updating and
correcting the streams documentation.

PR-URL: https://github.com/nodejs/node/pull/6947
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2016-06-06 08:17:19 -07:00
Julian Duque 71996506e9 doc: add added: information for dns
Got the information from git history and I ignored previous version of
dns attached to `node.dns` (pre v0.1.16).

There is a case where `dns.resolveNaptr` were intented to be in v0.7.12 and
it was reverted and addec back on `v0.9.12`, I left the latest version
when module was introduced. Same for `dns.resolvePtr` who was referenced
before but it was only added on `v6.0.0`

Refs: https://github.com/nodejs/node/issues/6578
PR-URL: https://github.com/nodejs/node/pull/7021
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-06-03 12:32:09 -07:00
Julian Duque bed44c94a0 doc: add added: information for path
Got the information from git history mostly, I ignored previous path
methods attached to `node.path` (pre v0.1.16).

Refs: https://github.com/nodejs/node/issues/6578
PR-URL: https://github.com/nodejs/node/pull/6985
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
2016-06-03 12:30:17 -07:00
Italo A. Casas 8bccc9e6c8 doc: add added information for net
Ref: https://github.com/nodejs/node/issues/6578
PR-URL: https://github.com/nodejs/node/pull/7038
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-06-02 17:15:22 -07:00
James M Snell 83e32266b6 doc: general improvements to punycode.md copy
PR-URL: https://github.com/nodejs/node/pull/7025
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2016-06-02 16:35:56 -07:00