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
Ben Noordhuis
409d413363
doc: remove uses of v8::Isolate::GetCurrent()
...
v8::Isolate::GetCurrent() is slated for deprecation. Replace its uses
in the addons documentation with v8::Object::GetIsolate(), etc.
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:03:02 +01:00
Alex Yursha
08ec897f82
doc: fix typo in buffer module documentation
...
PR-URL: https://github.com/iojs/io.js/pull/1169
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-03-17 12:25:31 +01:00
Yosuke Furukawa
b2e00e38dc
http: add flushHeaders and deprecate flush
...
PR-URL: https://github.com/iojs/io.js/pull/1156
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Christian Tellnes <christian@tellnes.no >
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-03-17 00:54:11 +01:00
Steven Vercruysse
e6e616fdcb
doc: fix '\\' typos on Windows
...
This commit changes the Windows examples in path.markdown to
correctly display '\\'.
PR-URL: https://github.com/joyent/node/pull/9412
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-03-16 16:20:16 -04:00
Alex Yursha
a28945b128
doc: reflect new require('events') behaviour
...
We don't need to do `require('events').EventEmitter` any longer.
PR-URL: https://github.com/iojs/io.js/pull/975
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com >
2015-03-16 11:30:07 +01:00
FangDun Cai
7a5b023bac
doc: fix vm module examples
...
PR-URL: https://github.com/iojs/io.js/pull/1147
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-03-13 23:14:20 +01:00
skenqbx
80e14d736e
doc: move checkServerIdentity option to tls.connect()
...
PR-URL: https://github.com/iojs/io.js/pull/1107
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-03-10 09:49:08 -04:00
Ryuichi Okumura
684a5878b6
doc: fix missing periods in url.markdown
...
PR-URL: https://github.com/iojs/io.js/pull/1115
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-03-10 09:37:31 -04:00
Yazhong Liu
f8c893dd39
doc: fix confusion markdown in util.markdown
...
PR-URL: https://github.com/iojs/io.js/pull/1097
Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com >
2015-03-08 14:49:06 -07:00
Evan Lucas
0f7c8ebeea
doc: replace article "an" with "a" in net docs
...
PR-URL: https://github.com/iojs/io.js/pull/1093
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-03-07 12:41:57 -06:00
Trevor Norris
78581c8d90
buffer: add indexOf() method
...
Add Buffer#indexOf(). Support strings, numbers and other Buffers. Also
included docs and tests.
Special thanks to Sam Rijs <srijs@airpost.net > for first proposing this
change.
PR-URL: https://github.com/iojs/io.js/pull/561
Reviewed-by: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Brian White <mscdex@mscdex.net >
Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com >
2015-03-04 14:16:11 -07:00
Sam Roberts
9741291fe9
doc: fix child_process heading depth
...
Addition of the Sync/Async headers didn't indent all the sub-headers.
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
PR-URL: https://github.com/iojs/io.js/pull/1038
2015-03-03 11:21:33 -08:00
Robert Kowalski
c8110692a5
doc: add explanations for querystring
...
- add an article: `decode a non-utf8 string`
- explain default and fallback behaviour of `querystring.unescape`
PR-URL: https://github.com/joyent/node/pull/9259
Reviewed-by: Julien Gilli <julien.gilli@joyent.com >
2015-03-03 10:03:42 -05:00
h7lin
8fb711e06c
doc: fix default value of opts.decodeURIComponent
...
In the documentation for querystring.parse, the documentation mentions
that the default value for options.decodeURIComponent is the
decodeURIComponent function, but it's actually the querystring.unescape
function.
PR-URL: https://github.com/joyent/node/pull/9259
Reviewed-by: Julien Gilli <julien.gilli@joyent.com >
2015-03-03 10:03:42 -05:00
Ryan Scheel
6d26990d32
doc: Clean up net.Socket
...
net.Socket::connect(options[, connectListener]) was missing, with the
relevant details found on the net.connect function. I moved the
appropriate documentation over and then rewrote the documentation for
the function to say that it just creates a socket and calls the connect
method on it. I also changed the other net.Socket::connect variants to
say they are like the options version but called with a specific
options object.
net.connect and other functions were called methods even though they
don't use the `this` binding, so I changed method to function where
appropriate.
Finally, I added a missing period to the end of the module summary.
It's not really related to the rest of the changes, but benjamingr
noticed it.
PR-URL: https://github.com/iojs/io.js/pull/951
Reviewed-By: Sam Roberts <vieuxtech@gmail.com >
Reviewed-By: Christian Tellnes <christian@tellnes.no >
2015-03-01 19:36:00 +01:00
Benjamin Gruenbaum
c380ac6e98
doc: suggest alternatives to deprecated APs
...
At the moment users who want to use `fs.exists` get a warning that the
method is deprecated but do not get offered an alternative in the page.
This PR suggests `fs.stat` and `fs.access` as alternatives while
keeping the warning about the use case in place.
Fixes: https://github.com/iojs/io.js/issues/1002
PR-URL: https://github.com/iojs/io.js/pull/1007
Reviewed-By: Brian White <mscdex@mscdex.net >
Reviewed-By: Christian Tellnes <christian@tellnes.no >
2015-03-01 18:46:28 +01:00
Chris Dickinson
cf0306cd71
doc: update stability index
...
This simplifies the stability index to 4 levels:
0 - deprecated
1 - experimental / feature-flagged
2 - stable
3 - locked
Domains has been downgraded to deprecated, assert has been
downgraded to stable. Timers and Module remain locked. All
other APIs are now stable.
PR-URL: https://github.com/iojs/io.js/pull/943
Fixes: https://github.com/iojs/io.js/issues/930
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: Vladimir Kurchatkin <vladimir.kurchatkin@gmail.com >
2015-02-27 14:23:01 -08:00
Benjamin Gruenbaum
f83d380647
doc: update os.markdown
...
Some doc update based on improvement ideas I remember from when I used this module in node:
- Mention windows returns 0 for `nice` values (which is obvious, but io makes no attempt to calculate something similar or return undefined, 0 is returned)
- Mention platform and arch are aliases for `process` properties.
- Document possible return values where appropriate, add examples in others.
- Rename title in order to match other titles in the navigation.
- Fix line that was over 80 characters long.
PR-URL: https://github.com/iojs/io.js/pull/976
Reviewed-By: Christian Tellnes <christian@tellnes.no >
Reviewed-By: Brian White <mscdex@mscdex.net >
Reviewed-By: Vladimir Kurchatkin <vladimir.kurchatkin@gmail.com >
2015-02-27 15:22:38 +01:00
Brendan Ashworth
2e2cf81476
doc: fix process.stdout reference to console.log
...
This commit changes the word introduction to the code block to be
explicitly correct, and changes the `d` variable to `msg` for clarity.
PR-URL: https://github.com/iojs/io.js/pull/964
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: Nicu Micleușanu <micnic90@gmail.com >
Reviewed-By: Vladimir Kurchatkin <vladimir.kurchatkin@gmail.com >
2015-02-26 13:06:35 -05:00
silverwind
c5050d8e4d
doc: fix 'dhparam' description of tls.createServer
...
fixes #958
Fixes: https://github.com/iojs/io.js/issues/958
PR-URL: https://github.com/iojs/io.js/pull/968
Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp >
2015-02-26 23:44:50 +09:00
Evan Lucas
2ca22aacbd
http: emit abort event from ClientRequest
...
ClientRequest will now emit an abort event the first time abort()
is called.
Semver: Minor
Fixes: https://github.com/joyent/node/issues/9278
PR-URL: https://github.com/iojs/io.js/pull/945
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com >
2015-02-25 16:40:31 -05:00
Benjamin Gruenbaum
06ee782f24
doc: document 'unhandledRejection' and 'rejectionHandled'
...
Documents the new unhandled rejection detection API.
Documents the new unhandledRejection/rejectionHandled events in the process
docuemntation. As agreed on in this issue:
https://github.com/iojs/io.js/issues/256#event-241385784
PR-URL: https://github.com/iojs/io.js/pull/946
Reviewed-By: Domenic Denicola <domenic@domenicdenicola.com >
Reviewed-By: Sam Roberts <vieuxtech@gmail.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-02-25 11:44:53 -06:00
Ryan Scheel
b65dade102
doc: update documentation.markdown for io.js.
...
PR-URL: https://github.com/iojs/io.js/pull/950
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-02-25 10:06:51 -05:00
Sam Roberts
87e4bfd582
doc: link cluster worker.send() to child.send()
...
PR-URL: https://github.com/iojs/io.js/pull/839
Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com >
2015-02-25 00:48:26 -08:00
René Kooi
3ab9b92e90
doc: fix stream _writev header size
...
PR-URL: https://github.com/iojs/io.js/pull/916
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-02-21 21:36:44 +01:00
Bruno Jouhier
c82e580a50
fs: properly handle fd passed to truncate()
...
Currently, fs.truncate() silently fails when a file descriptor
is passed as the first argument. This commit changes this
behavior to properly call fs.ftruncate().
PR-URL: https://github.com/joyent/node/pull/9161
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Timothy J Fontaine <tjfontaine@gmail.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Conflicts:
lib/fs.js
2015-02-21 12:13:21 -05:00
Roman Reiss
ed240f44f7
doc: document 'ciphers' option of tls.connect
...
This option has been there for a long time, but has never been
documented. It's functionally identical to the server counterpart.
PR-URL: https://github.com/iojs/io.js/pull/845
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-02-18 15:15:18 +01:00
jigsaw
0555b3c785
doc: fix typo miliseconds -> milliseconds
...
PR-URL: https://github.com/iojs/io.js/pull/865
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
2015-02-17 10:55:13 -05:00
Roman Reiss
77f35861d0
tls: more secure defaults
...
This updates the default cipher suite to an more secure list, which
prefers strong ciphers with Forward Secrecy. Additionally, it enables
`honorCipherOrder` by default.
Noteable effect of this change is that the insecure RC4 ciphers are
disabled and that Chrome negotiates a more secure ECDHE cipher.
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Fedor Indutny <fedor@indutny.com >
PR-URL: https://github.com/iojs/io.js/pull/826
2015-02-16 12:33:12 +01:00
Charmander
f0296933f8
doc: correct it's to its in process
...
"This event is emitted when io.js empties its event loop..."
PR-URL: https://github.com/iojs/io.js/pull/837
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-02-13 16:36:40 -05:00
Debjeet Biswas
4ca7cca84a
doc: grammar fix in smalloc
...
PR-URL: https://github.com/joyent/node/pull/9164
Reviewed-by: Colin Ihrig <cjihrig@gmail.com >
2015-02-13 13:37:25 -05:00
Dan Dascalescu
30dca66958
doc: fix code syntax
...
Add a ';' to the end of a function call in documentation.
PR-URL: https://github.com/joyent/node/pull/9198
Reviewed-by: Trevor Norris <trev.norris@gmail.com >
2015-02-13 13:37:25 -05:00
Andrei Sedoi
8c1df7a8a8
doc: use correct signature for assert()
...
The message argument is optional for both assert() and
assert.ok(). This commit makes message optional for assert().
PR-URL: https://github.com/joyent/node/pull/9003
Reviewed-By: Colin Ihrig <cjihrig@gmail.com >
Reviewed-By: Trevor Norris <trev.norris@gmail.com >
2015-02-13 13:37:24 -05:00
Omer Wazir
ba40942ad2
doc: fix sentence grammar timers.markdown
...
Just added ', it' because the phrasing did not seem correct.
PR-URL: https://github.com/iojs/io.js/pull/815
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-02-13 13:18:31 -05:00
Omer Wazir
cb5560bd62
doc: Close code span correctly
...
The code span is closed with a straight quote instead of the correct
back tick being used.
PR-URL: https://github.com/iojs/io.js/pull/814
Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com >
2015-02-11 22:20:12 -08:00
Ryan Seys
c3c2fbdf83
doc: change effect to affect in errors.md
...
PR-URL: https://github.com/iojs/io.js/pull/799
Reviewed-By: Evan Lucas <evanlucas@me.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-02-11 14:24:43 -05:00
Yosuke Furukawa
400d6e56f9
doc: fix libuv link
...
PR-URL: https://github.com/iojs/io.js/pull/803
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-02-11 17:01:22 +01:00
Rudolf Meijering
15d156e3ec
doc: fix wording in fs.appendFile
...
PR-URL: https://github.com/iojs/io.js/pull/801
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-02-11 10:42:25 -05:00
Chris Dickinson
dbf75924f1
doc: update error links
...
PR-URL: https://github.com/iojs/io.js/pull/793
Reviewed-by: Rod Vagg <rod@vagg.org >
2015-02-10 19:39:41 -08:00
Chris Dickinson
7e2235aebb
doc: add error documentation
...
PR-URL: https://github.com/iojs/io.js/pull/789
Reviewed-by: Rod Vagg <rod@vagg.org >
Reviewed-By: Trevor Norris <trev.norris@gmail.com >
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
2015-02-10 17:58:10 -08:00
Haoliang Gao
1151016d0a
doc: fix typo in crypto
...
PR-URL: https://github.com/iojs/io.js/pull/765
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-02-09 13:34:56 +01:00
Haoliang Gao
7c568684b8
doc: change the order of crypto.publicDecrypt
...
PR-URL: https://github.com/iojs/io.js/pull/767
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
2015-02-09 13:33:26 +01:00
Vladimir Kurchatkin
3f473ef141
assert: introduce deepStrictEqual
...
`deepStrictEqual` works the same way as `strictEqual`, but
uses `===` to compare primitives and requires prototypes of
equal objects to be the same object.
Fixes: https://github.com/joyent/node/issues/7161
Fixes: https://github.com/iojs/io.js/issues/620
PR-URL: https://github.com/iojs/io.js/pull/639
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-by: Rod Vagg <rod@vagg.org >
2015-02-09 14:14:20 +03:00
Roman Reiss
828d19a1f6
doc: fix dns.lookup options example
...
PR-URL: https://github.com/iojs/io.js/pull/757
Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com >
2015-02-08 11:03:37 -08:00