Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc/api
AgeCommit message (Collapse)Author
2020-01-072020-01-07, Version v13.6.0 (Current)v13.6.0Ruben Bridgewater
Notable changes: * assert: * Implement `assert.match()` and `assert.doesNotMatch()` (Ruben Bridgewater) https://github.com/nodejs/node/pull/30929 * events: * Add `EventEmitter.on` to async iterate over events (Matteo Collina) https://github.com/nodejs/node/pull/27994 * Allow monitoring error events (Gerhard Stoebich) https://github.com/nodejs/node/pull/30932 * fs: * Allow overriding `fs` for streams (Robert Nagy) https://github.com/nodejs/node/pull/29083 * perf_hooks: * Move `perf_hooks` out of experimental (legendecas) https://github.com/nodejs/node/pull/31101 * repl: * Implement ZSH-like reverse-i-search (Ruben Bridgewater) https://github.com/nodejs/node/pull/31006 * tls: * Add PSK (pre-shared key) support (Denys Otrishko) https://github.com/nodejs/node/pull/23188 PR-URL: https://github.com/nodejs/node/pull/31238
2020-01-06http2: set default enableConnectProtocol to 0ZYSzys
PR-URL: https://github.com/nodejs/node/pull/31174 Refs: https://tools.ietf.org/html/rfc8441#section-9.1 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-01-06doc: use code markup/markdown in headersRuben Bridgewater
This also allows us to remove backslash escaping for `[` and `]` inside of header code, which makes the bare markdown more readable. Refs: https://github.com/nodejs/node/pull/31086 PR-URL: https://github.com/nodejs/node/pull/31149 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-01-06doc: update REPL documentation to instantiate the REPLRuben Bridgewater
The documentation currently states that it's not intended to directly instantiate REPL instances. It is unknown for what reason that's recommended as it does seem a proper way to handle new REPL instances. PR-URL: https://github.com/nodejs/node/pull/30928 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2020-01-03esm: better error message for unsupported URLThomas
The default ESM loader supports only file and data URLs. This PR adds better error message for it. PR-URL: https://github.com/nodejs/node/pull/31129 Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc: improve explanation of package.json "type" fieldRonald J Kimball
Regardless of the value of the `"type"` field, `.mjs` files are always treated as ES modules and `.cjs` files are always treated as CommonJS. PR-URL: https://github.com/nodejs/node/pull/27516 Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03module: unflag resolve selfGuy Bedford
PR-URL: https://github.com/nodejs/node/pull/31002 Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc: clarify role of writable.cork()Colin Grant
The syntax of the sentence describing the role of writable.cork() was unclear. This rephrase aims to make the distinction between writing to the buffer and draining immediately to the underlying destination clearer - while keeping performance considerations clearly in mind. PR-URL: https://github.com/nodejs/node/pull/30442 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Denys Otrishko <shishugi@gmail.com>
2020-01-03perf_hooks: move perf_hooks out of experimentallegendecas
PR-URL: https://github.com/nodejs/node/pull/31101 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03assert: implement `assert.match()` and `assert.doesNotMatch()`Ruben Bridgewater
This adds a new functionality to the assertion module: a dedicated check for regular expressions. So far it's possible to use `assert.ok(regexp.test(string))`. This is not ideal though when it comes to the error message, since it's not possible to know how either of the input values look like. It's just known that the assertion failed. This allows to pass through the regular expression and the input string. The string is then matched against the regular expression and reports a expressive error message in case of a failure. PR-URL: https://github.com/nodejs/node/pull/30929 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
2020-01-03esm: empty ext from pkg type/main doesnt affect formatBradley Farias
This ensures files with unknown extensions like foo.bar are not loaded as CJS/ESM when imported as a main entry point and makes sure that those files would maintain the same format even if loaded after the main entrypoint. PR-URL: https://github.com/nodejs/node/pull/31021 Reviewed-By: Guy Bedford <guybedford@gmail.com>
2020-01-03doc: fix createDiffieHellman generator typeTobias Nießen
OpenSSL does not provide a straight-forward way to implement a non-integer generator, so createDiffieHellman never supported anything other than a number as the generator. (This only applies to the signature where the first argument is the size of the prime, and therefore a number.) Refs: https://github.com/nodejs/node-v0.x-archive/pull/7086 Refs: https://github.com/nodejs/node/pull/21782 PR-URL: https://github.com/nodejs/node/pull/31121 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Sam Roberts <vieuxtech@gmail.com>
2020-01-03module: self resolve bug fix and esm orderingGuy Bedford
PR-URL: https://github.com/nodejs/node/pull/31009 Reviewed-By: Jan Krems <jan.krems@gmail.com>
2020-01-03doc: update mode type for mkdir() functionscjihrig
This commit updates the documentation for fs.mkdir(), fs.mkdirSync(), and fsPromises.mkdir() to reflect the fact that their mode option can be a string. PR-URL: https://github.com/nodejs/node/pull/31115 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2020-01-03doc: update mode type for process.umask()cjihrig
This commit updates the documentation for process.umask() to reflect the fact that the mode option can be a string. PR-URL: https://github.com/nodejs/node/pull/31115 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2020-01-03doc: update mode type for fs open() functionscjihrig
This commit updates the documentation for fs.open(), fs.openSync(), and fsPromises.open() to reflect the fact that their mode option can be a string. PR-URL: https://github.com/nodejs/node/pull/31115 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2020-01-03doc: update mode type for fchmod() functionscjihrig
fs.fchmod() and fs.fchmodSync() both support strings as their mode argument. This commit updates the documentation to reflect this. PR-URL: https://github.com/nodejs/node/pull/31115 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2020-01-03doc: update parameter type for fsPromises.chmod()cjihrig
This was overlooked in https://github.com/nodejs/node/pull/31085. PR-URL: https://github.com/nodejs/node/pull/31115 Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2020-01-03doc: improve dns introductionRich Trott
The introductory paragraphs for the `dns` module do not explain what the module is for. Add a short (two brief sentences) explanation. It also emphasizes that functions in the dns module are divided into two categories, but that there is only one function in one of the categories, making the whole categories thing a bit odd to emphasize. Keep the material about the distinctions without discussing categories. There are other incidental revisions (changing an example IP to `example.org` and so on). PR-URL: https://github.com/nodejs/node/pull/31090 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2020-01-03doc: update parameter type for fs.chmod()Santosh Yadav
The mode parameter of fs.chmod() and fs.chmodSync() can be a string or an integer. This change updates the documentation, which currently omits string as a valid type for mode. PR-URL: https://github.com/nodejs/node/pull/31085 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2020-01-03doc,wasi: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,vm: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,worker: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,v8: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,util: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,zlib: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,url: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,tty: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,tls: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,timers: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,string_decoder: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,stream: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,repl: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,readline: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,querystring: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,punycode: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,process: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,perf_hooks: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,path: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,os: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,net: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,module: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,inspector: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,https: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,http2: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,http: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc: use code markup/markdown in headers in globals documentationRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,fs: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,events: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2020-01-03doc,esm: use code markup/markdown in headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-16 23:53:09 +0300