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
2021-08-07stream: utility consumers for web and node.js streamsJames M Snell
Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/nodejs/node/pull/39594 Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2021-08-06lib: expose `DOMException` as globalXadillaX
Refs: https://github.com/nodejs/node/issues/39098 PR-URL: https://github.com/nodejs/node/pull/39176 Fixes: https://github.com/nodejs/node/issues/39098 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-08-06doc: add missing change to resolver ctorLuan Devecchi
PR-URL: https://github.com/nodejs/node/pull/39610 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
2021-08-06dns: add "tries" option to Resolve optionsLuan Devecchi
PR-URL: https://github.com/nodejs/node/pull/39610 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
2021-08-06stream: add isDisturbed helperRobert Nagy
Adds a helper util used to determine whether a stream has been disturbed (read or cancelled). Refs: https://github.com/nodejs/node/issues/39627 PR-URL: https://github.com/nodejs/node/pull/39628 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2021-08-06doc: fix typo in `url.md`Howie Zhao
PR-URL: https://github.com/nodejs/node/pull/39666 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2021-08-05crypto: implement webcrypto.randomUUIDMichaël Zasso
Refs: https://wicg.github.io/uuid/ Refs: https://www.chromestatus.com/feature/5689159362543616 PR-URL: https://github.com/nodejs/node/pull/39648 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2021-08-03stream: duplexifyRobert Nagy
PR-URL: https://github.com/nodejs/node/pull/39519 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2021-08-02stream: add readableDidRead if has been read fromRobert Nagy
Adds did read accessor used to determine whether a readable has been read from. PR-URL: https://github.com/nodejs/node/pull/39589 Refs: https://github.com/nodejs/undici/pull/907 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2021-08-01doc: add missing `introduced_in` metadataRichard Lau
Fixes doc build warnings: ``` Failed to add alternative version links to webstreams Failed to add alternative version links to async_context ``` PR-URL: https://github.com/nodejs/node/pull/39575 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Beth Griggs <bgriggs@redhat.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-07-30doc: add code examples to `Writable.destroy()` and `Writable.destroyed`Juan José Arboleda
PR-URL: https://github.com/nodejs/node/pull/39491 Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-302021-07-29, Version 16.6.0 (Current)Beth Griggs
This is a security release. Notable Changes: - CVE-2021-22930: Use after free on close http2 on stream canceling (High) [#39423](https://github.com/nodejs/node/pull/39423) - (SEMVER-MINOR) deps: update V8 to 9.2.230.21 (Michaël Zasso) [#39470](https://github.com/nodejs/node/pull/39470) - inspector: mark as stable (Gireesh Punathil) [#37748](https://github.com/nodejs/node/pull/37748) - punycode: add pending deprecation (Antoine du Hamel) [#38444](https://github.com/nodejs/node/pull/38444) - (SEMVER-MINOR) repl: enable --experimental-repl-await /w opt-out (hemanth.hm) [#34733](https://github.com/nodejs/node/pull/34733) PR-URL: https://github.com/nodejs/node/pull/39534
2021-07-292021-07-29, Version 14.17.4 'Fermium' (LTS)Richard Lau
This is a security release. Notable Changes: - CVE-2021-22930: Use after free on close http2 on stream canceling (High) This releases fixes some regressions with internationalization introduced by the ICU updates in Node.js 14.17.0 and 14.17.1. PR-URL: https://github.com/nodejs/node/pull/39466
2021-07-28http: decodes url.username and url.password for authorization headerLew Gordon
This change properly decodes the url.username and url.password for the authorization header constructed from the URL object for http(s) requests. Fixes: https://github.com/nodejs/node/issues/31439 PR-URL: https://github.com/nodejs/node/pull/39310 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-28doc: add code example to `fs.truncate` methodJuan José Arboleda
PR-URL: https://github.com/nodejs/node/pull/39454 Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-28doc: add code example to `http.createServer` methodJuan José Arboleda
PR-URL: https://github.com/nodejs/node/pull/39455 Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-27doc: add PerformanceObserver `buffered` documentlegendecas
The option buffered is not about queueing the PerformanceEntrys with an event loop task or not. The option buffered in the spec is about filling the observer with the global PerformanceEntry buffer. The current (and the spec) behavior is different with Node.js version <= v16.0.0. PR-URL: https://github.com/nodejs/node/pull/39514 Refs: https://w3c.github.io/performance-timeline/#observe-method Refs: https://nodejs.org/dist/latest-v14.x/docs/api/perf_hooks.html#perf_hooks_performanceobserver_observe_options Refs: https://github.com/nodejs/node/pull/39297 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2021-07-27doc: fix crypto.hkdf callback derivedKey typeFilip Skokan
PR-URL: https://github.com/nodejs/node/pull/39453 Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-26doc,lib,test: rename HKDF 'key' argumentTobias Nießen
PR-URL: https://github.com/nodejs/node/pull/39474 Refs: https://github.com/nodejs/node/issues/39471 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Zeyu Yang <himself65@outlook.com> Reviewed-By: Filip Skokan <panva.ip@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-07-25stream: mark compose as experimentalRobert Nagy
PR-URL: https://github.com/nodejs/node/pull/39494 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-21stream: compose with async functionsRobert Nagy
Enables async function support for stream.compose. PR-URL: https://github.com/nodejs/node/pull/39435 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-19doc: remove _Addenda_ from headersRich Trott
PR-URL: https://github.com/nodejs/node/pull/39427 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-19inspector: mark as stableGireesh Punathil
The module has been there for a while, evidence of usage in the field exists, and we have good test coverage for it. Last API change has been 18 months ago. Refs: https://github.com/nodejs/node/issues/37440#issuecomment-785763306 PR-URL: https://github.com/nodejs/node/pull/37748 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-19doc: fix broken internal link in http.mdRich Trott
PR-URL: https://github.com/nodejs/node/pull/39425 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-19doc: remove typo (extra ' character)Nikita Rykov
PR-URL: https://github.com/nodejs/node/pull/39414 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-19stream: add stream.composeRobert Nagy
Refs: #32020 PR-URL: https://github.com/nodejs/node/pull/39029 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
2021-07-17deps: update to cjs-module-lexer@1.2.2Guy Bedford
PR-URL: https://github.com/nodejs/node/pull/39402 Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Jan Krems <jan.krems@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2021-07-17repl: enable --experimental-repl-await /w opt-outhemanth.hm
Unflags top-level await for the REPL by enabling --experimental-repl-await by default. Opt-out is supported via --no-experimental-repl-await. PR-URL: https://github.com/nodejs/node/pull/34733 Reviewed-By: Guy Bedford <guybedford@gmail.com>
2021-07-15fs: add FileHandle.prototype.readableWebStream()James M Snell
Adds an experimental `readableWebStream()` method to `FileHandle` that returns a web `ReadableStream` Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/nodejs/node/pull/39331 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2021-07-15process: add api to enable source-maps programmaticallylegendecas
Add `process.setSourceMapsEnabled` to enable source-maps programmatically. PR-URL: https://github.com/nodejs/node/pull/39085 Reviewed-By: Ben Coe <bencoe@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-14stream: add CompressionStream and DecompressionStreamJames M Snell
Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/nodejs/node/pull/39348 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2021-07-14stream: implement TextEncoderStream and TextDecoderStreamJames M Snell
Experimental as part of the web streams implementation Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/nodejs/node/pull/39347 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2021-07-142021-07-14, Version 16.5.0 (Current)Michaël Zasso
Notable changes: deps: * upgrade npm to 7.19.1 (npm team) https://github.com/nodejs/node/pull/39225 fs: * (SEMVER-MINOR) allow empty string for temp directory prefix (Voltrex) https://github.com/nodejs/node/pull/39028 stream: * (SEMVER-MINOR) implement Web Streams API (James M Snell) https://github.com/nodejs/node/pull/39062 PR-URL: https://github.com/nodejs/node/pull/39373
2021-07-13stream: implement streams to webstreams adaptersJames M Snell
Experimental adapters for the webstreams API Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/nodejs/node/pull/39134 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2021-07-13doc: fix typos in Web Streams API documentationTobias Nießen
PR-URL: https://github.com/nodejs/node/pull/39351 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2021-07-13doc: do not use tilde for "about" or "approximately"Rich Trott
Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/special-characters PR-URL: https://github.com/nodejs/node/pull/39344 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-07-13doc: use consistent abbreviation formattingRich Trott
Refs: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/bits-bytes-terms PR-URL: https://github.com/nodejs/node/pull/39343 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-07-12stream: destroy readable on read errorRobert Nagy
PR-URL: https://github.com/nodejs/node/pull/39342 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2021-07-11doc: replace outdated `util.promisify` timer examples with referencesfoxxyz
PR-URL: https://github.com/nodejs/node/pull/39164 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-07-08doc: add annotation to writeFile `data` as `Object`Jacob
Fixes: https://github.com/nodejs/node/issues/39152 PR-URL: https://github.com/nodejs/node/pull/39167 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-07-07doc: fix boldface punctuation for full sentencesRich Trott
If an entire sentence is in boldface, then generally the terminating punctuation should as well. PR-URL: https://github.com/nodejs/node/pull/39278 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2021-07-07doc: fix constants usage in fs.access exampleCyrille Bourgois
PR-URL: https://github.com/nodejs/node/pull/39289 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-07-06doc: update Node-api version matrixMichael Dawson
- add 14.x version in which Node-api version 8 was added. Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: https://github.com/nodejs/node/pull/39197 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
2021-07-03doc: remove unnecessary module format commentsRich Trott
Now that the docs have toggles for CJS vs. ESM, there is no need to include a comment explaining which module type is being used. PR-URL: https://github.com/nodejs/node/pull/39219 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
2021-07-03doc: use more consistent formatting for deprecationsRich Trott
Most deprecations do not end with a full-stop/period, but three of them do. Well, not anymore after this change. PR-URL: https://github.com/nodejs/node/pull/39218 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
2021-07-03doc: use "pull request" instead of "PR" in packages.mdRich Trott
PR-URL: https://github.com/nodejs/node/pull/39213 Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
2021-07-03doc: move v8.stopCoverage() to expected location in docRich Trott
PR-URL: https://github.com/nodejs/node/pull/39212 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-07-03doc: move vm.measureMemory() to expected location in docRich Trott
PR-URL: https://github.com/nodejs/node/pull/39211 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com>
2021-07-01doc: fix broken link in errors.mdRich Trott
PR-URL: https://github.com/nodejs/node/pull/39200 Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-06-30doc: correct JavaScript primitive value names in n-api.mdlegendecas
PR-URL: https://github.com/nodejs/node/pull/39129 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: James M Snell <jasnell@gmail.com>