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-04-17doc: missing bracketsWilliam Bonawentura
PR-URL: https://github.com/nodejs/node/pull/32657 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
2020-04-17doc: improve consistency in usage of NULLMichael Dawson
- add backticks around use of NULL - convert from null to NULL where we mean NULL Signed-off-by: Michael Dawson <michael_dawson@ca.ibm.com> PR-URL: https://github.com/nodejs/node/pull/32726 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Christopher Hiller <boneskull@boneskull.com>
2020-04-17Revert "n-api: detect deadlocks in thread-safe function"Gabriel Schulhof
This reverts commit aeb7084fe6446350ec032e9819746126811bf44f. The solution creates incorrect behaviour on Windows. Re: https://github.com/nodejs/node-addon-api/pull/697#issuecomment-612993476 Signed-off-by: Gabriel Schulhof <gabriel.schulhof@intel.com> PR-URL: https://github.com/nodejs/node/pull/32880 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
2020-04-17doc: improve net docsRobert Nagy
Refer back to streams docs for further and more accurate description of behavior details. Refs: https://github.com/nodejs/node/issues/31916 PR-URL: https://github.com/nodejs/node/pull/32811 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Denys Otrishko <shishugi@gmail.com>
2020-04-14doc: add transform stream destroy() return valuecjihrig
PR-URL: https://github.com/nodejs/node/pull/32788 Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2020-04-14cli, report: move --report-on-fatalerror to stablecjihrig
This commit moves the last experimental feature of diagnostic reports to stable status. PR-URL: https://github.com/nodejs/node/pull/32496 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2020-04-14doc: remove warning from `response.writeHead`Cecchi MacNaughton
The example referenced as being potentially unsafe specifies Content-Length correctly. PR-URL: https://github.com/nodejs/node/pull/32700 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
2020-04-14doc: improve AsyncLocalStorage sampleAndrey Pechkurov
PR-URL: https://github.com/nodejs/node/pull/32757 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2020-04-14doc: document `buffer.from` returns internal pool bufferHarshitha KP
Fixes: https://github.com/nodejs/node/issues/22139 Co-authored-by: Mritunjay Goutam <mritunjaygoutam2204@gmail.com> PR-URL: https://github.com/nodejs/node/pull/32703 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2020-04-14async_hooks: merge run and exit methodsAndrey Pechkurov
PR-URL: https://github.com/nodejs/node/pull/31950 Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
2020-04-14doc: add useful v8 option sectionNimit
This adds new section for v8 options and --max-old-space-size Fixes: https://github.com/nodejs/node/issues/32252 PR-URL: https://github.com/nodejs/node/pull/32262 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
2020-04-14doc: split process.umask() entry into twoRich Trott
Split doc entries for process.umask() into one entry for process.umask() (which is deprecated) and another for `process.umask(mask)` which is not deprecated. PR-URL: https://github.com/nodejs/node/pull/32711 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
2020-04-14perf_hooks: allow omitted parameters in 'performance.measure'himself65
Make `startMark` and `endMark` parameters optional. PR-URL: https://github.com/nodejs/node/pull/32651 Fixes: https://github.com/nodejs/node/issues/32647 Refs: https://www.w3.org/TR/user-timing-2/#measure-method Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2020-04-14n-api: detect deadlocks in thread-safe functionGabriel Schulhof
We introduce status `napi_would_deadlock` to be used as a return status by `napi_call_threadsafe_function` if the call is made with `napi_tsfn_blocking` on the main thread and the queue is full. PR-URL: https://github.com/nodejs/node/pull/32689 Fixes: https://github.com/nodejs/node/issues/32615 Signed-off-by: Gabriel Schulhof <gabriel.schulhof@intel.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2020-04-14doc: clarify behavior of napi_get_typedarray_infoMichael Dawson
Signed-off-by: Michael Dawson <michael_dawson@ca.ibm.com> Fixes: https://github.com/nodejs/node/issues/32089 PR-URL: https://github.com/nodejs/node/pull/32603 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-04-14util: add `maxStrLength` option to `inspect` functionunknown
Refs: https://github.com/nodejs/node/issues/25478 PR-URL: https://github.com/nodejs/node/pull/32392 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Matheus Marchini <mat@mmarchini.me> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: James M Snell <jasnell@gmail.com>
2020-04-14doc: remove optional parameter from markdown anchor linkRich Trott
Fix up a few instances so that lines don't xceed 80 characters. PR-URL: https://github.com/nodejs/node/pull/32671 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2020-04-14doc: clarify `listening` eventHarshitha KP
Co-authored-by: Divyanshu <dsinecos@gmail.com> PR-URL: https://github.com/nodejs/node/pull/32581 Reviewed-By: Anna Henningsen <anna@addaleax.net>
2020-04-07async_hooks: move to lazy destroy hook registration in AsyncResourceAndrey Pechkurov
PR-URL: https://github.com/nodejs/node/pull/32429 Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
2020-04-07doc: correct version metadata for Readable.fromDave Vandyke
PR-URL: https://github.com/nodejs/node/pull/32639 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2020-04-07doc: clarify docs fs.watch exception may be emittedJuan José Arboleda
Fixes: https://github.com/nodejs/node/issues/29894 PR-URL: https://github.com/nodejs/node/pull/32513 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2020-04-07doc: add unreachable code on events examplehimself65
PR-URL: https://github.com/nodejs/node/pull/32364 Reviewed-By: Anna Henningsen <anna@addaleax.net>
2020-04-07doc: clarify `length` param in `buffer.write`Harshitha KP
`buffer.write` documentation has an incaccuracy w.r.t the `length` parameter: It says default number of bytes written is `buf.length - offset`. Change it to: If the buffer has sufficient space from the offset, the string is written upto `length`. If the buffer is short in space, only `buf.length - offset` bytes are written. Refs: https://github.com/nodejs/node/pull/32104#discussion_r388524733 PR-URL: https://github.com/nodejs/node/pull/32119 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2020-04-07doc: document that server.address() can return nullThomas Watson
PR-URL: https://github.com/nodejs/node/pull/32519 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-04-07doc: return type of `crypto.getFips()` may changeRichard Lau
Document that the return type of `crypto.getFips()` may change in a future semver-major release from a `number` to a `boolean`. PR-URL: https://github.com/nodejs/node/pull/32580 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Signed-off-by: Richard Lau <riclau@uk.ibm.com>
2020-04-07doc: fix return type of `crypto.getFips()`Richard Lau
`crypto.getFips()` returns a number, not a boolean. PR-URL: https://github.com/nodejs/node/pull/32580 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Signed-off-by: Richard Lau <riclau@uk.ibm.com>
2020-04-07doc: clarify `requireManualDestroy` optionHarshitha KP
Fixes: https://github.com/nodejs/node/issues/32409 PR-URL: https://github.com/nodejs/node/pull/32514 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
2020-04-07module: expose exports conditions to loadersJan Krems
PR-URL: https://github.com/nodejs/node/pull/31303 Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
2020-04-07worker: support MessagePort to workers dataJuan José Arboleda
PR-URL: https://github.com/nodejs/node/pull/32278 Fixes: https://github.com/nodejs/node/issues/32250 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
2020-04-07doc: add missing changes: entry for dns.ALLAnna Henningsen
Refs: https://github.com/nodejs/node/pull/32183 PR-URL: https://github.com/nodejs/node/pull/32617 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2020-04-07fs: make parameters optional for readSyncLucas Holmquist
This makes the offset, length and position parameters optional by passing in an options object. PR-URL: https://github.com/nodejs/node/pull/32460 Reviewed-By: Anna Henningsen <anna@addaleax.net>
2020-04-07doc: improve fs.read documentationHachimi Aa (Sfeir)
PR-URL: https://github.com/nodejs/node/pull/29270 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2020-04-07module: path-only CJS exports extension searchingGuy Bedford
PR-URL: https://github.com/nodejs/node/pull/32351 Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com> Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
2020-04-01doc: deprecate process.umask() with no argumentscjihrig
This commit introduces a documentation deprecation for calling process.umask() with no arguments. PR-URL: https://github.com/nodejs/node/pull/32499 Fixes: https://github.com/nodejs/node/issues/32321 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
2020-03-31doc: update context-aware section of addon docGabriel Schulhof
Replace the portion of the context-aware addon example that advocates for managing the life cycle of the per-addon-instance data using a weak reference with code that illustrates how to manage its life cycle using an environment cleanup hook. Signed-off-by: Gabriel Schulhof <gabriel.schulhof@intel.com> PR-URL: https://github.com/nodejs/node/pull/28659 Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2020-03-30dns: add dns.ALL hints flag constantmurgatroid99
PR-URL: https://github.com/nodejs/node/pull/32183 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
2020-03-30doc: deprecate process.mainModuleAntoine du HAMEL
PR-URL: https://github.com/nodejs/node/pull/32232 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2020-03-30doc: stream.end(cb) cb can be invoked with errorPranshu Srivastava
Update docs that the optional callback passed to `writable.end` can be invoked in case of an error as well. PR-URL: https://github.com/nodejs/node/pull/32238 Fixes: https://github.com/nodejs/node/issues/31220 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2020-03-30fs: add fs.readv()Sk Sajidul Kadir
Fixes: https://github.com/nodejs/node/issues/2298 PR-URL: https://github.com/nodejs/node/pull/32356 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
2020-03-30doc: fix typo in http2 docsNitin Kumar
PR-URL: https://github.com/nodejs/node/pull/32292 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com>
2020-03-29doc: use uppercase on windows pathhimself65
PR-URL: https://github.com/nodejs/node/pull/32294 Reviewed-By: Bartosz Sosnowski <bartosz@janeasystems.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2020-03-29doc,crypto: clarify oaepHash option's impactFilip Skokan
PR-URL: https://github.com/nodejs/node/pull/32340 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2020-03-29http: increase default header size from 8KB to 16KBunknown
Fixes: https://github.com/nodejs/node/issues/27645 PR-URL: https://github.com/nodejs/node/pull/32520 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
2020-03-29doc: add missing changes: entry for mkdirAnna Henningsen
Refs: https://github.com/nodejs/node/pull/31530 PR-URL: https://github.com/nodejs/node/pull/32490 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ben Coe <bencoe@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2020-03-27doc: add link to DNS definitionunknown
PR-URL: https://github.com/nodejs/node/pull/32228 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2020-03-272020-03-26 Version 13.12.0 (Current)Myles Borins
macOS package notarization and a change in builder configuration: The macOS binaries for this release, and future 13.x releases, are now being compiled on macOS 10.15 (Catalina) with Xcode 11 to support package notarization, a requirement for installing on .pkg files on macOS 10.15 and later. Previous builds of Node.js 13.x were compiled on macOS 10.11 (El Capitan) with Xcode 10. As binaries are still being compiled to support a minimum of macOS 10.10 (Yosemite) we do not anticipate this having a negative impact on Node.js 13.x users with older versions of macOS. Notable changes: * build: * macOS package notarization (Rod Vagg) https://github.com/nodejs/node/pull/31459 * deps: * upgrade npm to 6.14.4 (Ruy Adorno) https://github.com/nodejs/node/pull/32495 * update to uvwasi 0.0.6 (Colin Ihrig) https://github.com/nodejs/node/pull/32309 * upgrade to libuv 1.35.0 (Colin Ihrig) https://github.com/nodejs/node/pull/32204 * lib: * add --disable-proto option to cli (Gus Caplan) https://github.com/nodejs/node/pull/32279 * node_report: * move diagnostic reports to stable (Colin Ihrig) https://github.com/nodejs/node/pull/32242 * worker: * allow URL in Worker constructor (Antoine du HAMEL) https://github.com/nodejs/node/pull/31664 * util: * use a global symbol for `util.promisify.custom` (ExE Boss) https://github.com/nodejs/node/pull/31672 PR-URL: https://github.com/nodejs/node/pull/32376
2020-03-26doc: remove extraneous sentence in events.mdRich Trott
Since the previous sentence describes `10` as a default, and the following sentence explains how to modify that default, it is unnecessary to explain that "Obviously, not all events should be limited to just 10 listeners." PR-URL: https://github.com/nodejs/node/pull/32457 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
2020-03-26doc: remove unnecessary "obvious(ly)" modifiers in esm.mdRich Trott
Remove "obvious" and "obviously" in two places in esm.md. It may be obvious to some, but likely not everyone or else it probably wouldn't be worth mentioning/documenting. PR-URL: https://github.com/nodejs/node/pull/32457 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
2020-03-26doc: trim wording in n-api.md text about exceptionsRich Trott
PR-URL: https://github.com/nodejs/node/pull/32457 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
2020-03-26doc: update async_hooks.mdVictor
Typo `runAndReturn` -> `runSyncAndReturn` PR-URL: https://github.com/nodejs/node/pull/32382 Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-16 11:42:24 +0300