summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* buffer: add indexOf() methodTrevor Norris2015-03-041-0/+13
| | | | | | | | | | | | | 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>
* doc: add TC meeting 2015-02-18 minutesRod Vagg2015-03-041-0/+129
| | | | | PR-URL: https://github.com/iojs/io.js/pull/1051 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: fix child_process heading depthSam Roberts2015-03-031-2/+2
| | | | | | | 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
* doc: add explanations for querystringRobert Kowalski2015-03-031-1/+5
| | | | | | | | - 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>
* doc: fix default value of opts.decodeURIComponenth7lin2015-03-031-1/+1
| | | | | | | | | | 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>
* doc: Clean up net.SocketRyan Scheel2015-03-011-44/+42
| | | | | | | | | | | | | | | | | | | | | | 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>
* doc: suggest alternatives to deprecated APsBenjamin Gruenbaum2015-03-011-3/+9
| | | | | | | | | | | | 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>
* doc: update stability indexChris Dickinson2015-02-2735-65/+42
| | | | | | | | | | | | | | | | | | | 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>
* doc: update os.markdownBenjamin Gruenbaum2015-02-271-8/+16
| | | | | | | | | | | | | | | 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>
* doc: fix process.stdout reference to console.logBrendan Ashworth2015-02-261-3/+3
| | | | | | | | | | 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>
* doc: fix 'dhparam' description of tls.createServersilverwind2015-02-261-3/+4
| | | | | | | | 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>
* http: emit abort event from ClientRequestEvan Lucas2015-02-251-0/+7
| | | | | | | | | | | 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>
* doc: document 'unhandledRejection' and 'rejectionHandled'Benjamin Gruenbaum2015-02-251-0/+62
| | | | | | | | | | | | | | 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>
* doc: update documentation.markdown for io.js.Ryan Scheel2015-02-251-2/+2
| | | | | PR-URL: https://github.com/iojs/io.js/pull/950 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: link cluster worker.send() to child.send()Sam Roberts2015-02-251-4/+6
| | | | | PR-URL: https://github.com/iojs/io.js/pull/839 Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com>
* doc: fix footer sizingJeremiah Senkpiel2015-02-221-1/+1
| | | | | | | | reduced to the minimal amount, any less shows a white bar. Semver: patch PR-URL: https://github.com/iojs/io.js/pull/860 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
* doc: fix stream `_writev` header sizeRené Kooi2015-02-211-1/+1
| | | | | PR-URL: https://github.com/iojs/io.js/pull/916 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* fs: properly handle fd passed to truncate()Bruno Jouhier2015-02-211-1/+2
| | | | | | | | | | | | | | 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
* doc: add TC meeting 2015-02-04 minutesRod Vagg2015-02-201-0/+107
| | | | | | Closes #701 PR-URL: https://github.com/iojs/io.js/pull/876 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: document 'ciphers' option of tls.connectRoman Reiss2015-02-181-0/+3
| | | | | | | | 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>
* doc: fix typo miliseconds -> millisecondsjigsaw2015-02-171-1/+1
| | | | | PR-URL: https://github.com/iojs/io.js/pull/865 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* tls: more secure defaultsRoman Reiss2015-02-161-30/+18
| | | | | | | | | | | | | 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
* doc: correct `it's` to `its` in processCharmander2015-02-131-1/+1
| | | | | | | "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>
* doc: grammar fix in smallocDebjeet Biswas2015-02-131-1/+1
| | | | | PR-URL: https://github.com/joyent/node/pull/9164 Reviewed-by: Colin Ihrig <cjihrig@gmail.com>
* doc: fix code syntaxDan Dascalescu2015-02-131-1/+1
| | | | | | | 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>
* doc: use correct signature for assert()Andrei Sedoi2015-02-131-1/+1
| | | | | | | | | 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>
* doc: fix sentence grammar timers.markdownOmer Wazir2015-02-131-1/+1
| | | | | | | 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>
* doc: increase mark class contrast ratioOmer Wazir2015-02-121-2/+1
| | | | | PR-URL: https://github.com/iojs/io.js/pull/824 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
* doc: better font-smoothing for firefoxJeremiah Senkpiel2015-02-121-1/+1
| | | | | | | does the same thing for firefox as 'antialiased' does for webkit. PR-URL: https://github.com/iojs/io.js/pull/820 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
* doc: disable font ligaturesRoman Reiss2015-02-121-0/+2
| | | | | PR-URL: https://github.com/iojs/io.js/pull/816 Reviewed-By: Nicu Micleușanu <micnic90@gmail.com>
* doc: Close code span correctlyOmer Wazir2015-02-111-1/+1
| | | | | | | | 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>
* doc: change effect to affect in errors.mdRyan Seys2015-02-111-1/+1
| | | | | | PR-URL: https://github.com/iojs/io.js/pull/799 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: fix libuv linkYosuke Furukawa2015-02-111-1/+1
| | | | | PR-URL: https://github.com/iojs/io.js/pull/803 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* doc: fix wording in fs.appendFileRudolf Meijering2015-02-111-1/+1
| | | | | PR-URL: https://github.com/iojs/io.js/pull/801 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* doc: update error linksChris Dickinson2015-02-101-3/+3
| | | | | PR-URL: https://github.com/iojs/io.js/pull/793 Reviewed-by: Rod Vagg <rod@vagg.org>
* doc: add error documentationChris Dickinson2015-02-103-0/+472
| | | | | | | 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>
* doc: fix typo in cryptoHaoliang Gao2015-02-091-1/+1
| | | | | PR-URL: https://github.com/iojs/io.js/pull/765 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* doc: change the order of crypto.publicDecryptHaoliang Gao2015-02-091-5/+5
| | | | | PR-URL: https://github.com/iojs/io.js/pull/767 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* assert: introduce `deepStrictEqual`Vladimir Kurchatkin2015-02-091-3/+14
| | | | | | | | | | | | | `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>
* doc: fix dns.lookup options exampleRoman Reiss2015-02-081-2/+2
| | | | | PR-URL: https://github.com/iojs/io.js/pull/757 Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com>
* doc: update antiquated process.versions outputBen Noordhuis2015-02-071-8/+8
| | | | | PR-URL: https://github.com/iojs/io.js/pull/750 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: update node.js references in api docsBen Noordhuis2015-02-0730-207/+208
| | | | | | Fixes: https://github.com/iojs/io.js/issues/740 PR-URL: https://github.com/iojs/io.js/pull/750 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* dns: allow dns.lookup() to return all addressesRoman Reiss2015-02-061-14/+22
| | | | | | | | | | | This commit adds the 'all' option to dns.lookup(), allowing all lookup results to be returned. Semver: Minor Fixes: https://github.com/iojs/io.js/issues/736 PR-URL: https://github.com/iojs/io.js/pull/744 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* stream: simpler stream constructonSam Newman2015-02-041-2/+73
| | | | | | | | | | | Adds simplified constructor pattern, allowing users to provide "read", "write", "transform", "flush", and "writev" functions as stream options in lieu of subclassing. Semver: minor PR-URL: https://github.com/iojs/io.js/pull/697 Fixes: https://github.com/iojs/readable-stream/issues/102 Reviewed-By: Chris Dickinson <christopher.s.dickinson@gmail.com>
* doc: add TC meeting 2015-01-28 minutesRod Vagg2015-02-041-0/+179
| | | | | PR-URL: https://github.com/iojs/io.js/pull/699 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
* tools: add release tool and docs, remove old toolsRod Vagg2015-02-043-74/+209
| | | | | | | | | Also added binary download documentation to the README.md and GPG release key fingerprint for @rvagg. PR-URL: https://github.com/iojs/io.js/pull/681 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Fedor Indutny <fedor@indutny.com>
* crypto: support passwords in publicEncryptCalvin Metcalf2015-02-021-0/+3
| | | | | | | | | | Private keys may be used along with publicEncrypt since the private key includes the public one. This adds the ability to use encrypted private keys which previously threw an error. This commit also makes sure the user exposed functions have names. PR-URL: https://github.com/iojs/io.js/pull/626 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* events: remove indeterminancy from event orderingSam Roberts2015-02-021-4/+8
| | | | | | | | | | | | | The order of the `newListener` and `removeListener` events with respect to the actual adding and removing from the underlying listeners array should be deterministic. There is no compelling reason for leaving it indeterminate. Changing the ordering is likely to result in breaking code that was unwittingly relying on the current behaviour, and the indeterminancy makes it impossible to use these events to determine when the first or last listener is added for an event. PR-URL: https://github.com/iojs/io.js/pull/687 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
* docs: add note about default padding in cryptoCalvin Metcalf2015-01-291-1/+3
| | | | | | | | | Adds a note that the default padding for publicDecrypt/privateEncrypt is RSA_PKCS1_PADDING instead of RSA_PKCS1_OAEP_PADDING as it is for privateDecrypt/publicEncrypt. PR-URL: https://github.com/iojs/io.js/pull/659 Reviewed-By: Brendan Ashworth <brendan.ashworth@me.com>
* buffer: implement `iterable` interfaceVladimir Kurchatkin2015-01-281-0/+29
| | | | | | | | | This makes possible to use `for..of` loop with buffers. Also related `keys`, `values` and `entries` methods are added for feature parity with `Uint8Array`. PR-URL: https://github.com/iojs/io.js/pull/525 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>