Benjamin Gruenbaum
0f09b8db28
doc: don't recommend domains for error handling
...
Remove the suggestion to use domains for exception handling. Add clarity
to "unhandledException".
Fixes: https://github.com/nodejs/io.js/issues/2055
PR-URL: https://github.com/nodejs/io.js/pull/2056
Reviewed-By: Trev Norris <trev.norris@gmail.com >
Reviewed-By: Chris Dickinson <chris@neversaw.us >
2015-07-03 15:22:27 -06:00
Ivan Yan
c370bd3aea
doc: make the abbreviation 1MM clear
...
Refs: https://github.com/nodejs/io.js/pull/2050
PR-URL: https://github.com/nodejs/io.js/pull/2053
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2015-06-25 11:42:09 -04:00
Сковорода Никита Андреевич
96165f9be2
doc: minor clarification in the modules API doc.
...
PR-URL: https://github.com/nodejs/io.js/pull/1983
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-06-16 05:42:05 +03:00
Roman Reiss
9f3a03f0d4
doc: add references to crypto.getCurves()
...
This adds references to the newly available crypto.getCurves method
where appropriate.
PR-URL: https://github.com/nodejs/io.js/pull/1918
Reviewed-By: Brian White <mscdex@mscdex.net >
2015-06-09 22:17:55 +02:00
Brian White
38d1afc24d
crypto: add getCurves() to get supported ECs
...
PR-URL: https://github.com/nodejs/io.js/pull/1914
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-06-08 12:35:41 -04:00
Rich Trott
ff39ecb914
doc: remove comma splice
...
Remove comma splice. Edit for clarity and concision.
PR-URL: https://github.com/nodejs/io.js/pull/1900
Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com >
2015-06-07 22:25:24 +02:00
Ryan Petschek
deb8b87dc9
doc: add note about available ECC curves
...
Added instructions on how to get the elliptic curves supported by the
OpenSSL installation in the crypto.createECDH() constructor. Also made
a few minor grammar fixes within the same paragraph.
PR-URL: https://github.com/nodejs/io.js/pull/1913
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-06-07 20:47:55 +02:00
cjihrig
6e78e5feaa
os: add homedir()
...
os.homedir() calls libuv's uv_os_homedir() to retrieve the current
user's home directory.
PR-URL: https://github.com/nodejs/io.js/pull/1791
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Rod Vagg <rod@vagg.org >
2015-06-05 22:58:14 -04:00
Yosuke Furukawa
353e26e3c7
fs: Add string encoding option for Stream method
...
Add string encoding option for fs.createReadStream and
fs.createWriteStream. and check argument type more strictly
PR-URL: https://github.com/nodejs/io.js/pull/1845
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-06-05 10:30:32 +09:00
Yosuke Furukawa
8357c5084b
fs: set encoding on fs.createWriteStream
...
Enable encoding option on fs.createWriteStream.
PR-URL: https://github.com/nodejs/io.js/pull/1844
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-06-03 03:01:35 +09:00
Сковорода Никита Андреевич
89a5b9040e
doc: fix http.IncomingMessage.socket documentation
...
Remove the reference to net.Socket.verifyPeer().
That was removed in ea540c9 and was missed in the 032f80e .
Refer to the net.Socket instance by the .socket property.
This avoids unneeded confusion.
'.socket' is the variant that is used internally.
Add a markdown link to net.Socket.getPeerCertificate().
PR-URL: https://github.com/nodejs/io.js/pull/1867
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-06-02 00:04:21 +02:00
Tyler Anton
a79dece8ad
docs: add return value for sync fs functions
...
Clarify that synchronous functions in fs with no return value return
undefined.
Specify that fs.openSync() returns an integer and fs.existsSync()
returns true or false.
Fixes: https://github.com/joyent/node/issues/9313
PR: https://github.com/joyent/node/pull/9359
Reviewed-By: Julien Gilli <julien.gilli@joyent.com >
PORT-FROM: joyent/node @ 51fe319faf
PR-URL: https://github.com/nodejs/io.js/pull/1770
Reviewed-By: Roman Reiss <me@silverwind.io >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Conflicts:
doc/api/fs.markdown
2015-06-01 14:11:10 -04:00
Rich Trott
ff794498e7
doc: fs.*File() also accept encoding strings
...
Fixes: https://github.com/nodejs/io.js/issues/1797
PR-URL: https://github.com/nodejs/io.js/pull/1806
Reviewed-By: fishrock123@rocketmail.com
2015-05-27 15:53:14 -04:00
Steve Sharp
98649fd31a
doc: add documentation for AtExit hook
...
Fixes: https://github.com/nodejs/io.js/issues/999
PR-URL: https://github.com/nodejs/io.js/pull/1014
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-05-26 18:15:06 +02:00
Rich Trott
eb1856dfd1
doc: clarify stability of fs.watch and relatives
...
Fixes: https://github.com/nodejs/io.js/issues/1754
PR-URL: https://github.com/nodejs/io.js/pull/1775
Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-05-26 11:26:02 -04:00
Josh Gummersall
a74c2c9458
doc: state url decoding behavior
...
Explicitly states the fact that no decoding is performed on the url
path or pathname or the query string by default in the URL module.
Fixes: https://github.com/nodejs/io.js/issues/1538
PR-URL: https://github.com/nodejs/io.js/pull/1731
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-05-25 13:50:53 +02:00
Roman Reiss
cb381fe3e0
net: return this from setNoDelay and setKeepAlive
...
Modifies the Socket.setNoDelay and Socket.setKeepAlive methods to return
the socket instance instead of undefined, to allow for chaining.
PR-URL: https://github.com/nodejs/io.js/pull/1779
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-05-23 18:10:32 +02:00
Roman Reiss
39dde3222e
net,dgram: return this from ref and unref methods
...
Modifies the following methods to return the instance instead
of undefined, to allow for chaining these methods:
- net.Server.ref
- net.Server.unref
- net.Socket.ref
- net.Socket.unref
- dgram.Socket.ref
- dgram.Socket.unref
PR-URL: https://github.com/nodejs/io.js/pull/1768
Reviewed-By: Evan Lucas <evanlucas@me.com >
2015-05-23 06:57:00 +02:00
Maurice Butler
515afc6367
doc: path is ignored in url.format
...
Made it obvious that path is ignored in url.format
PR-URL: https://github.com/nodejs/io.js/pull/1753
2015-05-22 14:58:32 +02:00
Shigeki Ohtsu
9b35be5810
tls: make server not use DHE in less than 1024bits
...
DHE key lengths less than 1024bits is already weaken as pointed out in
https://weakdh.org/ . 1024bits will not be safe in near future. We
will extend this up to 2048bits somedays later.
PR-URL: https://github.com/nodejs/io.js/pull/1739
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Fedor Indutny <fedor@indutny.com >
2015-05-21 00:02:44 +09:00
Rich Trott
86dd244d9b
doc: add notes to child_process.fork() and .exec()
...
Adds notes about the difference to their POSIX counterparts.
PR-URL: https://github.com/nodejs/io.js/pull/1718
Fixes: https://github.com/nodejs/io.js/issues/224
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-05-20 14:21:06 +02:00
smikes
7d90c90aaf
doc: recommend against use of NODE_PATH
...
PR-URL: https://github.com/nodejs/io.js/pull/1708
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-05-17 20:25:07 +02:00
Josh Gummersall
fbaef40e63
doc: fix connectListener description in net docs
...
`connectListener` is registered as a listener to the 'connect' event
once. Update the documentation to reflect that behavior.
Fixes: https://github.com/nodejs/io.js/issues/901
PR-URL: https://github.com/nodejs/io.js/pull/1717
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-05-17 13:59:28 +02:00
Yazhong Liu
6edc900b95
repl: support non-array .scope, document it
...
REPL evaluate `.scope` when it needs to get a list of the variable names
available in the current scope. Do not throw if the output of such
evaluation is not array, just ignore it.
PR-URL: https://github.com/nodejs/io.js/pull/1682
Reviewed-By: Fedor Indutny <fedor@indutny.com >
2015-05-17 12:22:26 +02:00
Evan Lucas
d4726cde57
http,net,tls: return this from setTimeout methods
...
Modifies the setTimeout methods for the following prototypes:
- http.ClientRequest
- http.IncomingMessage
- http.OutgoingMessage
- http.Server
- https.Server
- net.Socket
- tls.TLSSocket
Previously, the above functions returned undefined. They now return
`this`. This is useful for chaining function calls.
PR-URL: https://github.com/nodejs/io.js/pull/1699
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-05-16 07:17:41 +02:00
Mike MacCana
5755fc099f
tls: update default ciphers to use gcm and aes128
...
AES-GCM or CHACHA20_POLY1305 ciphers must be used in current version of
Chrome to avoid an 'obsolete cryptography' warning.
Prefer 128 bit AES over 192 and 256 bit AES considering attacks that
specifically affect the larger key sizes but do not affect AES 128.
PR-URL: https://github.com/iojs/io.js/pull/1660
Reviewed-By: Fedor Indutny <fedor@indutny.com >
Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp >
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-05-11 13:37:48 +02:00
Roman Klauke
931a0d4634
src: add type check to v8.setFlagsFromString()
...
Calling v8.setFlagsFromString with e.g a function as a flag argument
gave no exception or warning that the function call will fail.
There is now an exception if the function gets called with the wrong
flag type (string is required) or that a flag is expected.
Other APIs already provide exceptions if the argument has not the
expected type.
PR-URL: https://github.com/iojs/io.js/pull/1652
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-05-08 19:09:45 +02:00
Nick Raienko
2a3a1909ab
doc: add require() lines to child.stdio example
...
PR-URL: https://github.com/iojs/io.js/pull/1504
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-05-02 15:55:36 -07:00
Alexander Gromnitsky
02388dbf40
doc: fix some cross-references
...
PR-URL: https://github.com/iojs/io.js/pull/1584
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-05-02 14:07:21 +02:00
Roman Reiss
b4ad5d7050
doc: improve http.request and https.request opts
...
This adds a few previously undocumented option to both functions.
PR-URL: https://github.com/iojs/io.js/pull/1551
Fixes: https://github.com/iojs/io.js/issues/1082
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-05-01 19:55:50 +02:00
Chris Dickinson
0450ce7db2
repl: add mode detection, cli persistent history
...
this creates a new internal module responsible for providing
the repl created via "iojs" or "iojs -i," and adds the following
options to the readline and repl subsystems:
* "repl mode" - determine whether a repl is strict mode, sloppy mode,
or auto-detect mode.
* historySize - determine the maximum number of lines a repl will store
as history.
The built-in repl gains persistent history support when the
NODE_REPL_HISTORY_FILE environment variable is set. This functionality
is not exposed to userland repl instances.
PR-URL: https://github.com/iojs/io.js/pull/1513
Reviewed-By: Fedor Indutny <fedor@indutny.com >
2015-04-30 19:33:05 -07:00
Ben Noordhuis
7dc8eec0a6
doc: deprecate smalloc module
...
Upcoming V8 changes will make it impossible to keep supporting the
smalloc module so deprecate it now and tell people to switch to
typed arrays.
PR-URL: https://github.com/iojs/io.js/pull/1566
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-04-30 19:44:49 +02:00
Evan Lucas
3c92ca2b5c
src: add ability to get/set effective uid/gid
...
Adds the following to process:
- `process.geteuid()`
- `process.seteuid(id)`
- `process.getegid()`
- `process.setegid(id)`
PR-URL: https://github.com/iojs/io.js/pull/1536
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-04-29 16:04:26 -05:00
Nick Raienko
e55fdc47a7
doc: fix util.deprecate example
...
PR-URL: https://github.com/iojs/io.js/pull/1535
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Julian Duque <julianduquej@gmail.com >
2015-04-28 10:12:13 -04:00
Evan Lucas
4abe2fa1cf
net: add lookup option to Socket.prototype.connect
...
Allows customization of the lookup function used when
Socket.prototype.connect is called using a hostname.
PR-URL: https://github.com/iojs/io.js/pull/1505
Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com >
Reviewed-By: Yosuke Furukawa <yosuke.furukawa@gmail.com >
2015-04-24 07:53:16 -05:00
Nick Raienko
b16a328ede
doc: add spaces to child.kill example
...
PR-URL: https://github.com/iojs/io.js/pull/1503
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Evan Lucas <evanlucas@me.com >
2015-04-22 21:54:43 -07:00
Trevor Norris
10e31ba56c
node: allow multiple arguments passed to nextTick
...
PR-URL: https://github.com/iojs/io.js/pull/1077
Reviewed-by: Colin Ihrig <cjihrig@gmail.com >
2015-04-15 17:02:21 -06:00
Jeremiah Senkpiel
93a1a07ef4
doc: remove keepAlive options from http.request
...
These can only be specified in the options for http.Agent
Fixes: https://github.com/iojs/io.js/issues/1300
PR-URL: https://github.com/iojs/io.js/pull/1392
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-04-11 10:46:17 -04:00
Alex Yursha
3ad6ea7c38
doc: remove redundant parameter in end listener.
...
PR-URL: https://github.com/iojs/io.js/pull/1387
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-04-11 06:53:41 +02:00
Jackson Tian
2bc3532461
doc: document Console class
...
document Console class to tell user can use it.
PR-URL: https://github.com/iojs/io.js/pull/1388
Fixes: https://github.com/iojs/io.js/issues/1359
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-04-11 06:47:30 +02:00
Jeremiah Senkpiel
69bc1382b7
doc: properly indent http.Agent keepAlive options
...
Fixes: https://github.com/iojs/io.js/issues/1300
PR-URL: https://github.com/iojs/io.js/pull/1384
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-04-09 11:23:39 -04:00
Johan Bergström
d726a177ed
build: Remove building against a shared V8
...
This action is to encourage packagers to not build against a
shared V8 library since even minor bumps of V8 can create issues.
PR-URL: https://github.com/iojs/io.js/pull/1331
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-04-07 15:02:42 +10:00
Kohei TAKATA
87053e8aee
doc: add back quote to boolean variable 'true'
...
PR-URL: https://github.com/iojs/io.js/pull/1338
Reviewed-By: Roman Reiss <me@silverwind.io >
2015-04-03 16:10:37 +02:00
Jeremiah Senkpiel
245ba1d658
doc: fix util.isObject documentation
...
Proposed functionality fix containing prior discussion:
https://github.com/iojs/io.js/pull/822
Fixes: https://github.com/iojs/io.js/issues/743
PR-URL: https://github.com/iojs/io.js/pull/1295
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com >
2015-03-31 10:51:23 -04:00
Brendan Ashworth
45814216ee
doc: fix format docs discrepancy
...
Only objects and symbols use `util.inspect`, others are simply
concatenated.
Fixes: https://github.com/iojs/io.js/issues/935
PR-URL: https://github.com/iojs/io.js/pull/1255
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-03-25 08:47:41 -07:00
Roman Reiss
e84dd5f651
doc: document repl on-demand module loading
...
Fixes: https://github.com/iojs/io.js/issues/992
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com >
PR-URL: https://github.com/iojs/io.js/pull/1249
2015-03-24 22:10:26 +01:00
Ben Noordhuis
99c79f8d41
doc: call js function in null context
...
It's good practice now to call JS functions that don't execute in a
specific scope with v8::Null() as the receiver. Update the addons
documentation.
PR-URL: https://github.com/iojs/io.js/pull/1125
Reviewed-By: Rod Vagg <rod@vagg.org >
Reviewed-By: Trevor Norris <trev.norris@gmail.com >
2015-03-21 14:05:20 +01:00
Ben Noordhuis
55abf34be5
doc: don't use using namespace v8
...
Wholesale importing an entire namespace with `using namespace` is a bad
practice. Remove it from the addons documentation and replace it with
proper `using` directives. Wrap code in a namespace while we are here.
PR-URL: https://github.com/iojs/io.js/pull/1125
Reviewed-By: Rod Vagg <rod@vagg.org >
Reviewed-By: Trevor Norris <trev.norris@gmail.com >
2015-03-21 14:05:18 +01:00
Ben Noordhuis
c4e1b82120
doc: replace v8::Handle<T> with v8::Local<T>
...
v8::Handle is on its way out, to be replaced with v8::Local. Update the
addons documentation accordingly.
PR-URL: https://github.com/iojs/io.js/pull/1125
Reviewed-By: Rod Vagg <rod@vagg.org >
Reviewed-By: Trevor Norris <trev.norris@gmail.com >
2015-03-21 14:05:15 +01:00
Ben Noordhuis
2f1b78347c
doc: remove unnecessary v8::HandleScopes
...
Remove unnecessary v8::HandleScope uses from the addons documentation.
C++ API callbacks run in an implicit v8::HandleScope, there is no need
to declare one in the callback function.
PR-URL: https://github.com/iojs/io.js/pull/1125
Reviewed-By: Rod Vagg <rod@vagg.org >
Reviewed-By: Trevor Norris <trev.norris@gmail.com >
2015-03-21 14:05:11 +01:00