summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* doc: add trace category for fs sync methodsChin Huang2018-05-081-0/+1
| | | | | | | | | | | | | | Add the trace category for file system synchronous methods to documentation so the users can enable it when they want to look into file system sync method trace data. PR-URL: https://github.com/nodejs/node/pull/20526 Refs: https://github.com/nodejs/node/pull/19649 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* fs: move fs/promises to fs.promisescjihrig2018-05-071-2/+2
| | | | | | | | | | | | | PR-URL: https://github.com/nodejs/node/pull/20504 Refs: https://github.com/nodejs/TSC/issues/389 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Shingo Inoue <leko.noor@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
* doc: excise "periodically" before "emit events"Jesse W. Collins2018-05-071-2/+1
| | | | | | | | | | "periodically" implies regular time intervals between emitted events, but as first example, "peer connects", implies, the time intervals may be irregular or unpredictable. PR-URL: https://github.com/nodejs/node/pull/20581 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
* doc: edit text about revoking deprecationsRich Trott2018-05-071-4/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | * "un-deprecation" ಠ_ಠ -> "revoking deprecations" * "From time-to-time" -> "Occastionally" * "semver-major" and "semver-minor" are jargon that readers who don't follow our issue tracker will not know. Remove the sentence as it doesn't really impact end users. The deprecation is revoked when it is revoked. Rules around the releases where deprecations can be revoked may be added to the COLLABORATOR_GUIDE in the extensive section about deprecations there. If so, great, but let's still remove it here as having the information scattered in two places makes it likely that one will be edited to contradict the other and then it won't be clear which one is correct. * Remove unneeded italics. The italicized sentence is not hugely critical information that we desperately want users to know. Most users won't care. They will only care about the deprecation message that they are looking up at that moment. PR-URL: https://github.com/nodejs/node/pull/20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: edit text for DEP0013Rich Trott2018-05-071-1/+1
| | | | | | | | | | | | | | | | | * v10.0.0 -> Node.js 10.0.0 * Parenthetical with URL rather than "PR" as a lot of people may not know what "PR" stands for but they will know what a URL is. Plus not hiding the URL means the text is more copy/paste-able. In this particular case, "PR 12562" is not more useful or informative than https://github.com/nodejs/node/pull/12562 so just use the URL. PR-URL: https://github.com/nodejs/node/pull/20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: minor edit to DEP0065Rich Trott2018-05-071-1/+1
| | | | | | | | | | | | | | Use "Node.js 6.0.0" instead of "Node.js v6.0.0". (We decided to drop "v" before version numbers to avoid confusion with the V8 JavaScript engine.) PR-URL: https://github.com/nodejs/node/pull/20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: fix minor typographical error in DEP0079 textRich Trott2018-05-071-1/+1
| | | | | | | | | | | | | | | | | | | | Change `backwards compatibility` to `backward compatibility`. (It's confusing because "backwards compatible" is acceptable because "backwards" can be used as an adverb like that. However, as an adjective, as in "backward compatibility", only "backward" will do. Easiest solution: Always use "backward" because it is OK in both cases. This is all compounded by the US vs UK English thing. US English tends to favor "backward", and we standardize on US English, so that's another point in favor of "backward" over "backwards" in this context.) PR-URL: https://github.com/nodejs/node/pull/20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: edit text for DEP0082Rich Trott2018-05-071-3/+2
| | | | | | | | | | | | Make deprecation text more concise and direct. PR-URL: https://github.com/nodejs/node/pull/20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: fix text for DEP0085Rich Trott2018-05-071-2/+2
| | | | | | | | | | | | | Fix a typographical error in deprecation text. Convert run-on sentence to two sentences (one in parentheses). PR-URL: https://github.com/nodejs/node/pull/20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: edit text for DEP0094Rich Trott2018-05-071-3/+3
| | | | | | | | | | | | Make deprecation text slightly more concise and direct. PR-URL: https://github.com/nodejs/node/pull/20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: edit text for DEP0012Rich Trott2018-05-071-1/+1
| | | | | | | | | | | | Fix awkward verb tense. PR-URL: https://github.com/nodejs/node/pull/20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: edit text for DEP0101Rich Trott2018-05-071-1/+1
| | | | | | | | | | | | Make the text slightly more concise. Fix awkward verb tense. PR-URL: https://github.com/nodejs/node/pull/20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: edit text for DEP0104Rich Trott2018-05-071-5/+5
| | | | | | | | | | | | Make the deprecation message a bit clear and concise. PR-URL: https://github.com/nodejs/node/pull/20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: add parameters for Http2Session:stream eventUjjwal Sharma2018-05-071-4/+7
| | | | | | | | | | | | | Add parameters for the callback for the Http2Session:stream event inline with the pattern in the rest of the documentation. Refs: https://github.com/nodejs/help/issues/877#issuecomment-381253464 PR-URL: https://github.com/nodejs/node/pull/20547 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* errors: remove ERR_INVALID_ARRAY_LENGTHRuben Bridgewater2018-05-071-5/+0
| | | | | | | | | | | This error code is obsolete, since the error message from ERR_OUT_OF_RANGE is more precise. It was only used a single time, so I went ahead and replced this. PR-URL: https://github.com/nodejs/node/pull/20484 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: update one more command in crypto.mdShobhit Chittora2018-05-071-1/+2
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/20500 Refs: https://github.com/nodejs/node/pull/20400 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: updates crypto doc with openssl list -cipher-algorithmsShobhit Chittora2018-05-061-6/+9
| | | | | | | | | PR-URL: https://github.com/nodejs/node/pull/20502 Refs: https://github.com/nodejs/node/issues/20385 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org>
* doc: fix N-API property descriptor documentationGabriel Schulhof2018-05-061-5/+4
| | | | | PR-URL: https://github.com/nodejs/node/pull/20433 Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* https: defines maxHeadersCount in the constructorDaiki Arai2018-05-051-0/+8
| | | | | | | | | | | | | In Refs, http.Server's maxHeadersCount field was defined in the constructor to make hidden class stable and so on. Also in https.Server, we can use maxHeadersCount the same as http via connectionListener. So, defines it in the constructor and documentation. Refs: https://github.com/nodejs/node/pull/9116 PR-URL: https://github.com/nodejs/node/pull/20359 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: fix manpage warningJérémy Lal2018-05-051-1/+0
| | | | | | | | | | | | LC_ALL=C.UTF-8 MANROFFSEQ='' MANWIDTH=80 man --warnings -E UTF-8 -l -Tutf8 -Z ./doc/node.1 > /dev/null mdoc warning: Empty input line #389 PR-URL: https://github.com/nodejs/node/pull/20383 Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
* doc: document using `domain` in REPLAyush Gupta2018-05-041-0/+15
| | | | | | | | | | | | | | Document that REPL uses the `domain` module to handle uncaught exceptions, and the side effects caused by it. PR-URL: https://github.com/nodejs/node/pull/20382 Fixes: https://github.com/nodejs/node/issues/19998 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: fix mkdtemp() documentationRich Trott2018-05-041-12/+8
| | | | | | | | | | | | Several minor fixes to the entries for `mkdtemp()`. The most significant is that a mistaken use of `fs.mkdtemp()` is corrected to `fsPromises.mkdtemp()`. PR-URL: https://github.com/nodejs/node/pull/20512 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Shingo Inoue <leko.noor@gmail.com>
* doc: update examples for fs.access()BeniCheni2018-05-041-4/+27
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/20460 Fixes: https://github.com/nodejs/node/issues/17508 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: cleanup n-api.md docMichael Dawson2018-05-031-6/+8
| | | | | | | | | | | Partial doc cleanup as per https://github.com/nodejs/node/issues/20421 PR-URL: https://github.com/nodejs/node/pull/20430 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: update Collaborator Guide referenceRich Trott2018-05-031-5/+5
| | | | | | | | | | | | | | In pull-requests.md: * Refer to the Collaborator Guide as Collaborator Guide and not Collaborator's Guide. That is how the doc describes itself and we should be consistent. PR-URL: https://github.com/nodejs/node/pull/20473 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: synchronize argument names for appendFile()Rich Trott2018-05-031-9/+9
| | | | | | | | | | | | | | | | | | | The documentation used `file` for the first argument to `appendFile()` functions. However, the code and (more importantly) thrown errors referred to it as `path`. The latter is especially important because context is not provided. So you're looking for a function that takes `path` but that string doesn't appear in your code *or* in the documentation. It's not until the end user looks at the source code of Node.js that they can figure out what's going on. This is why it is important that the names of variables in the documentation match that in the code. If we want to change this to `file`, then that's OK, but we need to do it in the source code and error messages too, not just in the docs. Changing the docs is the smallest change to synchronize everything so that's what this change does. PR-URL: https://github.com/nodejs/node/pull/20489 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: update cli flag in crypto.mdShobhit Chittora2018-05-031-1/+2
| | | | | | | | PR-URL: https://github.com/nodejs/node/pull/20400 Fixes: https://github.com/nodejs/node/issues/20385 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Shigeki Ohtsu <ohtsu@ohtsu.org>
* doc: add missing periods in documentation.mdVse Mozhet Byt2018-05-031-12/+10
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/20469 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: update writing-and-running-benchmarks.mdxsbchen2018-05-021-14/+12
| | | | | | | | | Refs: https://github.com/nodejs/node/commit/368517c0dc2576e1f8f315e53d0cfebb22acf9e2 PR-URL: https://github.com/nodejs/node/pull/20379 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
* doc: add http.ClientRequest maxHeadersCountDaiki Arai2018-05-021-1/+7
| | | | | | | | | | | In http.ClientRequest's doc, add maxHeadersCount as a public property. And in the description of server's one, change a hyphen to a comma. PR-URL: https://github.com/nodejs/node/pull/20361 Refs: https://github.com/nodejs/node/pull/20359 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: add squash guideline to pull-requests docRich Trott2018-05-021-3/+4
| | | | | | | | | | Tell the contributor to generally not squash commits during the pull request review process. PR-URL: https://github.com/nodejs/node/pull/20413 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: remove squash guideline from onboarding docRich Trott2018-05-021-1/+0
| | | | | | | | | | | | | | | | | | Although I agree with the guideline people should generally not squash commits in a pull request until the end (in other words, until it's time to land the PR), it is clear from comments and actions in the issue tracker that many do not share that view. This is fine by me, but I do think that we should our documentation should reflect our practices rather than being an aspirational statement. If we *do* wish to preserve this recommendation, it probably belongs in another document anyway as this is not a recommendation for Collaborators only but for anyone opening a pull request. PR-URL: https://github.com/nodejs/node/pull/20413 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: add more missing backticksVse Mozhet Byt2018-05-0335-648/+649
| | | | | | | | | | Also, fix some other nits in passing (formatting, punctuation, typos, redundancy, obsoleteness). PR-URL: https://github.com/nodejs/node/pull/20438 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* n-api: test and doc napi_throw() of a primitiveGabriel Schulhof2018-05-021-2/+2
| | | | | | | | | | Ensure that napi_throw() is able to throw a primitive value, and document that it is able to throw any JavaScript value. Fixes: https://github.com/nodejs/abi-stable-node/issues/309 PR-URL: https://github.com/nodejs/node/pull/20428 Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: add missing periods or colonsVse Mozhet Byt2018-05-0226-100/+97
| | | | | | | | | | | Some other formatting nits were fixed and some superfluous descriptions were simplified in passing. PR-URL: https://github.com/nodejs/node/pull/20401 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: mitigate `marked` bugVse Mozhet Byt2018-05-021-3/+4
| | | | | | | PR-URL: https://github.com/nodejs/node/pull/20411 Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: specify types of listener parameterVse Mozhet Byt2018-05-021-1/+2
| | | | | | | | | We cannot manage with `{any}` because `message` cannot be of `Symbol` or `undefined` types. PR-URL: https://github.com/nodejs/node/pull/20405 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: clarify FileHandle textRich Trott2018-05-011-5/+5
| | | | | | | | | | | | | | There is a paragraph about why the promise-based API uses `FileHandle` rather than a numeric `fd`. Unfortunately, the paragraph is a bit of word-salad. Edit it for clarity, grammar, and style. PR-URL: https://github.com/nodejs/node/pull/20450 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: remove unclear text from fs.write()Rich Trott2018-05-011-4/+0
| | | | | | | | | | | | | | | | There is a paragraph explaining that `fs.write()` cannot write a substring of the provided string. It's not clear what `buffer` refers to in that paragraph or even what the purpose of the paragraph is. There's no suggestion elsewhere that `fs.write()` should be expected to have a substring feature. Remove the paragraph. PR-URL: https://github.com/nodejs/node/pull/20450 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: edit fs.createReadStream() highWaterMarkRich Trott2018-05-011-3/+2
| | | | | | | | | | | | | Shorten the text about the `highWaterMark` value for the stream returned by `fs.createReadStream()`. PR-URL: https://github.com/nodejs/node/pull/20450 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
* doc: remove redundant table of contents for N-APIAyush Gupta2018-04-301-22/+0
| | | | | | | | | | | | | | Since the table of contents is built dynamically when building the documentation, the additional table of contents is redundant and an extra overhead to maintain. PR-URL: https://github.com/nodejs/node/pull/20395 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
* doc: add parameters for settings eventsUjjwal Sharma2018-05-011-4/+6
| | | | | | | | | | | | | Add parameters for the callback for the Http2Session:localSettings event and Http2Session:remoteSettings event inline with the pattern in the rest of the documentation. Refs: https://github.com/nodejs/help/issues/877#issuecomment-381253464 PR-URL: https://github.com/nodejs/node/pull/20371 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
* n-api: document the look of napi_external valuesGabriel Schulhof2018-04-301-0/+3
| | | | | | | | | | Describe what JavaScript values of type `napi_external` look like in JavaScript. Fixes: https://github.com/nodejs/abi-stable-node/issues/306 PR-URL: https://github.com/nodejs/node/pull/20426 Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
* n-api: document that native strings are copiedGabriel Schulhof2018-04-301-1/+3
| | | | | | | | | | | Mention that a copy is made of the native string by the napi_create_string_* APIs. Fixes: https://github.com/nodejs/abi-stable-node/issues/304 PR-URL: https://github.com/nodejs/node/pull/20425 Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
* doc: refine napi_get_property_names() docGabriel Schulhof2018-04-301-1/+3
| | | | | | | | | | Document that only enumerable, string-keyed properties are returned. Fixes: https://github.com/nodejs/abi-stable-node/issues/307 PR-URL: https://github.com/nodejs/node/pull/20427 Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
* 2018-04-30, Version 6.14.2 'Boron' (LTS)Myles Borins2018-04-301-0/+239
| | | | | | | | | | | Notable Change: * n-api: - n-api has been backported to v6.x. It is being landed as an experimental interface, and as such is landing in a Semver-Patch release. (Gabriel Schulhof) https://github.com/nodejs/node/pull/19447 PR-URL: https://github.com/nodejs/node/pull/19996
* doc: remove parenthetical in onboarding-extrasRich Trott2018-04-291-1/+1
| | | | | | | | | | | | | Remove "(I prefer the former)" from onboarding-extras. Without any explanation as to why one might prefer A over B, it probably raises more questions than it answers. PR-URL: https://github.com/nodejs/node/pull/20393 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: improve process event headersRuben Bridgewater2018-04-292-22/+20
| | | | | | | | | | The headers should be handled as all others as well and just indicate all arguments. PR-URL: https://github.com/nodejs/node/pull/20312 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* doc: improve assert docsRuben Bridgewater2018-04-291-81/+128
| | | | | | | | | | | This improves the error example output by reflecting the current state. It also makes sure the examples are up to date in general. `assert.throws` clarified the `ERR_AMBIGUOUS_ARGUMENT` error. PR-URL: https://github.com/nodejs/node/pull/20313 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
* http,https,tls: switch to WHATWG URL parserHackzzila2018-04-294-9/+22
| | | | | | | | | | | | | | | | | | This switches the url parser from `url.parse()` to the WHATWG URL parser while keeping `url.parse()` as fallback. Also add tests for invalid url deprecations and correct hostname checks. PR-URL: https://github.com/nodejs/node/pull/20270 Fixes: https://github.com/nodejs/node/issues/19468 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
View Lorry Controller Status