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-09-17readline: add `autoCommit` optionAntoine du Hamel
PR-URL: https://github.com/nodejs/node/pull/37947 Fixes: https://github.com/nodejs/node/issues/37287 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>
2021-09-17readline: introduce promise-based APIAntoine du Hamel
PR-URL: https://github.com/nodejs/node/pull/37947 Fixes: https://github.com/nodejs/node/issues/37287 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>
2021-09-15dns: runtime deprecate type coercion of `dns.lookup` optionsAntoine du Hamel
PR-URL: https://github.com/nodejs/node/pull/39793 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
2021-09-15doc: clarify that ObjectWrap requires manual cleanup on shutdownGerhard Stöbich
Clarify that ObjectWrap instances are not destroyed on process or worker shutdown and require manual destruction to avoid resource leaks. PR-URL: https://github.com/nodejs/node/pull/40074 Fixes: https://github.com/nodejs/node/issues/38816 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-09-15module: deprecate trailing slash pattern mappingsGuy Bedford
PR-URL: https://github.com/nodejs/node/pull/40039 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
2021-09-12dns: default to verbatim=true in dns.lookup()Ben Noordhuis
Switch the default from `ipv4first` to `verbatim` (return them exactly as the resolver sent them to us). PR-URL: https://github.com/nodejs/node/pull/39987 Fixes: https://github.com/nodejs/node/issues/31566 Refs: https://github.com/nodejs/node/issues/6307 Refs: https://github.com/nodejs/node/pull/20710 Refs: https://github.com/nodejs/node/pull/38099 Co-authored-by: treysis <treysis@gmx.net> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
2021-09-12esm: consolidate ESM loader hooksJacob
doc: update ESM hook examples esm: fix unsafe primordial doc: fix ESM example linting esm: allow source of type ArrayBuffer doc: update ESM hook changelog to include resolve format esm: allow all ArrayBuffers and TypedArrays for load hook source doc: tidy code & API docs doc: convert ESM source table header from Title Case to Sentence case doc: add detailed explanation for getPackageType esm: add caveat that ESMLoader::import() must NOT be renamed esm: tidy code declaration of getFormat protocolHandlers doc: correct ESM doc link (bad conflict resolution) doc: update ESM hook limitation for CJS esm: tweak preload description doc: update ESM getPackageType() example explanation PR-URL: https://github.com/nodejs/node/pull/37468 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: Geoffrey Booth <webmaster@geoffreybooth.com>
2021-09-10doc: fix CCM cipher example in MJSTobias Nießen
The original example used 'return' to terminate the current control flow, which is valid in CommonJS. When the example was copied and modified to use MJS syntax, the 'return' statement was left in but is not allowed. Refs: https://github.com/nodejs/node/pull/37594 PR-URL: https://github.com/nodejs/node/pull/39949 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-09-10src: add option to disable loading native addonsDominic Elm
PR-URL: https://github.com/nodejs/node/pull/39977 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
2021-09-08doc: fix property name 'detail' of performanceEntryChristian Boehlke
PR-URL: https://github.com/nodejs/node/pull/40019 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2021-09-08errors: disp ver on fatal except that causes exitDivlo
Display Node.js version at the end of stacktraces on fatal exception that causes exit. Easier for debugging so you don't have to ask "what node version are you on?", it is directly in the error the user copy/paste from when asking for help. Fixes: https://github.com/nodejs/node/issues/29731 PR-URL: https://github.com/nodejs/node/pull/38332 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Michaël Zasso <targos@protonmail.com>
2021-09-07doc: fix list indentation in corepack.mdAlexey Ten
PR-URL: https://github.com/nodejs/node/pull/40029 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Shingo Inoue <leko.noor@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-09-072021-09-07, Version 16.9.0 (Current)Michaël Zasso
Notable changes: crypto: * (SEMVER-MINOR) add RSA-PSS params to asymmetricKeyDetails (Tobias Nießen) https://github.com/nodejs/node/pull/39851 deps: * (SEMVER-MINOR) add corepack (Maël Nison) https://github.com/nodejs/node/pull/39608 * (SEMVER-MINOR) update V8 to 9.3.345.16 (Michaël Zasso) https://github.com/nodejs/node/pull/39947 module: * (SEMVER-MINOR) support pattern trailers (Guy Bedford) https://github.com/nodejs/node/pull/39635 stream: * (SEMVER-MINOR) add stream.compose (Robert Nagy) https://github.com/nodejs/node/pull/39029 PR-URL: https://github.com/nodejs/node/pull/40011
2021-09-07doc: fix history for `fs.WriteStream` `open` eventAntoine du Hamel
PR-URL: https://github.com/nodejs/node/pull/39972 Refs: https://github.com/nodejs/node/pull/33716 Refs: https://github.com/nodejs/node/pull/35993 Refs: https://github.com/nodejs/node/pull/35911 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2021-09-07doc: fix missing history version in `fs.md`Antoine du Hamel
Refs: https://github.com/nodejs/node/pull/33716 Refs: https://github.com/nodejs/node/pull/35993 Refs: https://github.com/nodejs/node/pull/35911 PR-URL: https://github.com/nodejs/node/pull/39972 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2021-09-05crypto: add rsa-pss keygen parametersFilip Skokan
PR-URL: https://github.com/nodejs/node/pull/39927 Reviewed-By: James M Snell <jasnell@gmail.com>
2021-09-03doc: add descriptions about when `options.mode` is ignoredRay
PR-URL: https://github.com/nodejs/node/pull/39881 Fixes: https://github.com/nodejs/node/issues/39859 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
2021-09-01doc: add missing changes to generateKeyPair(Sync)Tobias Nießen
Refs: https://github.com/nodejs/node/pull/26774 Refs: https://github.com/nodejs/node/pull/26960 PR-URL: https://github.com/nodejs/node/pull/39963 Reviewed-By: Filip Skokan <panva.ip@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-08-31doc: update WASI example to use import.meta.urlGuy Bedford
PR-URL: https://github.com/nodejs/node/pull/39925 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-08-31doc: move reference to OpenSSL flags SSL_OP_*Tobias Nießen
Refs: https://github.com/nodejs/node/pull/34050 PR-URL: https://github.com/nodejs/node/pull/39935 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-08-30doc: add docs for duplex.allowHalfOpen propertyTim Perry
PR-URL: https://github.com/nodejs/node/pull/39126 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-08-30fs: add docs and tests for `AsyncIterable` support in `fh.writeFile`Antoine du Hamel
Refs: https://github.com/nodejs/node/pull/37490 PR-URL: https://github.com/nodejs/node/pull/39836 Reviewed-By: Nitzan Uziely <linkgoron@gmail.com>
2021-08-30doc: anchor link parity between markdown and html-generated docsfoxxyz
Main changes: - Replace current HTML anchor generation to match header anchor generation in Github markdown. - Remove unnecessary double namespacing on generated anchors/links (E.G. `esm.md#loaders` instead of `esm.md#esm_loaders`). - Anchors/links are automatically prefixed with their respective modules when concatenated for usage in `all.html`. Benefits: - All anchor links within and between markdown API docs actually work. - Adding new anchor links no longer requires contributors to generate the HTML docs first to look up the correct anchors. - Anchors are much shorter. - All previous anchor links are preserved by generating hidden legacy anchors. PR-URL: https://github.com/nodejs/node/pull/39304 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-08-29crypto: add RSA-PSS params to asymmetricKeyDetailsTobias Nießen
Fixes: https://github.com/nodejs/node/issues/39837 Refs: https://github.com/openssl/openssl/pull/10568 PR-URL: https://github.com/nodejs/node/pull/39851 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Filip Skokan <panva.ip@gmail.com>
2021-08-28doc: reset added: version to REPLACEMELuigi Pinca
Documentation for `CompressionStream` and `DecompressionStream` was erroneously added in https://github.com/nodejs/node/commit/f57a0e4d8b and released in version 16.7.0. Reset the `added:` version to `REPLACEME`. Refs: https://github.com/nodejs/node/pull/39348 Refs: https://github.com/nodejs/node/pull/39899 PR-URL: https://github.com/nodejs/node/pull/39901 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
2021-08-26doc: move ERR_WORKER_UNSPPORTED_EXTENSION to legacyQingyu Deng
PR-URL: https://github.com/nodejs/node/pull/39788 Fixes: https://github.com/nodejs/node/issues/39124 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2021-08-26worker: remove file extension checkQingyu Deng
Fixes: https://github.com/nodejs/node/issues/39124 PR-URL: https://github.com/nodejs/node/pull/39788 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
2021-08-26doc: fix typo in webstreams.mdLuigi Pinca
`deccompressionStream.writable` -> `decompressionStream.writable`. PR-URL: https://github.com/nodejs/node/pull/39898 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2021-08-252021-08-25, Version 16.8.0 (Current)Michaël Zasso
Notable changes: doc: * deprecate type coercion for `dns.lookup` options (Antoine du Hamel) https://github.com/nodejs/node/pull/38906 stream: * (SEMVER-MINOR) add `stream.Duplex.from` utility (Robert Nagy) https://github.com/nodejs/node/pull/39519 * (SEMVER-MINOR) add `isDisturbed` helper (Robert Nagy) https://github.com/nodejs/node/pull/39628 util: * (SEMVER-MINOR) expose `toUSVString` (Robert Nagy) https://github.com/nodejs/node/pull/39814 PR-URL: https://github.com/nodejs/node/pull/39875
2021-08-25module: support pattern trailersGuy Bedford
PR-URL: https://github.com/nodejs/node/pull/39635 Reviewed-By: Bradley Farias <bradley.meck@gmail.com>
2021-08-25stream: add signal support to pipeline generatorsRobert Nagy
Generators in pipeline must be able to be aborted or pipeline can deadlock. PR-URL: https://github.com/nodejs/node/pull/39067 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-08-25deps: add corepackMaël Nison
Corepack provides shims for Yarn and pnpm in order to soften the developer experience when working on Node projects. Refs: https://github.com/nodejs/node/issues/15244 Refs: https://github.com/nodejs/TSC/issues/904 PR-URL: https://github.com/nodejs/node/pull/39608 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-08-22doc: move util.toUSVString() outside of deprecated groupLuigi Pinca
Refs: https://github.com/nodejs/node/pull/39814/files#r693445849 PR-URL: https://github.com/nodejs/node/pull/39840 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-08-22util: expose toUSVStringRobert Nagy
Expose toUSVString so it can be used by user libraries. PR-URL: https://github.com/nodejs/node/pull/39814 Refs: https://github.com/nodejs/undici/pull/986 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-08-19policy: canonicalize before resolving specifiersBradley Farias
PR-URL: https://github.com/nodejs/node/pull/37863 Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com> Co-authored-by: James M Snell <jasnell@gmail.com> Reviewed-By: Guy Bedford <guybedford@gmail.com>
2021-08-182021-08-17, Version 16.7.0 (Current)Danielle Adams
Notable changes: * fs: * experimental: add recursive cp method (Benjamin Coe) https://github.com/nodejs/node/pull/39372 PR-URL: https://github.com/nodejs/node/pull/39782
2021-08-17doc: deprecate type coercion for `dns.lookup` optionsAntoine du Hamel
PR-URL: https://github.com/nodejs/node/pull/38906 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2021-08-17doc: deprecate using non-boolean values in the `verbatim` optionAntoine du Hamel
PR-URL: https://github.com/nodejs/node/pull/38906 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2021-08-17doc: fix lint errors in packages.mdRich Trott
Code samples that use CJS-only syntax need to use the cjs markdown identifiers. PR-URL: https://github.com/nodejs/node/pull/39792 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Myles Borins <myles.borins@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>
2021-08-17doc: add example of self-reference in scoped packagesJesús Leganés-Combarro 'piranna
PR-URL: https://github.com/nodejs/node/pull/37630 Fixes: https://github.com/nodejs/node/issues/37618 Refs: https://github.com/nodejs/node/issues/37618#issuecomment-791888177 Co-authored-by: Michaël Zasso <targos@protonmail.com> Reviewed-By: Guy Bedford <guybedford@gmail.com>
2021-08-16doc: correct cjs code to match mjs codeRaz Luvaton
PR-URL: https://github.com/nodejs/node/pull/39509 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
2021-08-16doc: fix typo in hmac.paramNames defaultJustin
PR-URL: https://github.com/nodejs/node/pull/39766 Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Filip Skokan <panva.ip@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-08-14buffer: add endings option, remove Node.js specific encoding optionJames M Snell
Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/nodejs/node/pull/39708 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2021-08-13doc: fix `fs.rmdir` `recursive` option deprecation historyAntoine du Hamel
PR-URL: https://github.com/nodejs/node/pull/39728 Refs: https://github.com/nodejs/node/pull/35579 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-08-13doc: fixed variable names in queueMicrotask exampleashish maurya
fixed variable name in queueMicrotask where url variable was used instead of key PR-URL: https://github.com/nodejs/node/pull/39634 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2021-08-12url,buffer: implement URL.createObjectURLJames M Snell
Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/nodejs/node/pull/39693 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
2021-08-12buffer: add Blob.prototype.stream method and other cleanupsJames M Snell
Adds the `stream()` method to get a `ReadableStream` for the `Blob`. Also makes some other improvements to get the implementation closer to the API standard definition. Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/nodejs/node/pull/39693 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Bradley Farias <bradley.meck@gmail.com> Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
2021-08-12fs: add recursive cp methodbcoe
Introduces recursive cp method, based on fs-extra implementation. PR-URL: https://github.com/nodejs/node/pull/39372 Fixes: https://github.com/nodejs/node/issues/35880 Refs: https://github.com/nodejs/tooling/issues/98 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ian Sutherland <ian@iansutherland.ca>
2021-08-08doc: change "Version 4 UUID" to "version 4 UUID"Tobias Nießen
Refs: https://www.rfc-editor.org/rfc/rfc4122.txt PR-URL: https://github.com/nodejs/node/pull/39682 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Beth Griggs <bgriggs@redhat.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-08-07doc: update debugger.md description and examplesRich Trott
The console captures in debugger.md are out of date, showing the wrapper: function (exports, require, module, __filename, __dirname) { That wrapper is no longer shown in debug sessions. This also shortens and simplifies the description of the debugger in the lede. PR-URL: https://github.com/nodejs/node/pull/39661 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: James M Snell <jasnell@gmail.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-07-16 23:00:29 +0300