Commit Graph
5921 Commits
Author SHA1 Message Date
bcb85adee6 policy: canonicalize before resolving specifiers
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-09-04 15:14:55 +02:00
Rich Trott 9e772ca9a1 doc: fix lint errors in packages.md
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-09-04 15:14:54 +02:00
Jesús Leganés-Combarro 'pirannaandMichaël Zasso 2624c98207 doc: add example of self-reference in scoped packages
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-09-04 15:14:53 +02:00
Jayden Seric 95b9cc78d2 doc: fix YAML comment opening tags
Several YAML documentation comments incorrectly started with `<!--YAML`
instead of `<!-- YAML`, resulting in their content missing in the
rendered documentation.

PR-URL: https://github.com/nodejs/node/pull/38324
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-09-04 15:14:52 +02:00
Antoine du Hamel 49a7962d58 doc: fix fs.rmdir recursive option deprecation history
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-09-04 15:14:51 +02:00
ashish maurya 53300d33c7 doc: fixed variable names in queueMicrotask example
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-09-04 15:14:50 +02:00
Rich Trott df1e20aaf1 doc: update debugger.md description and examples
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>
2021-09-04 15:14:47 +02:00
Juan José Arboleda 48281ecfcd doc: add code examples to Writable.destroy() and Writable.destroyed
PR-URL: https://github.com/nodejs/node/pull/39491
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-09-04 15:14:41 +02:00
Lew Gordon 2bc301dcff http: decodes url.username and url.password for authorization header
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-09-04 15:14:39 +02:00
Juan José Arboleda a437de3c5f doc: add code example to http.createServer method
PR-URL: https://github.com/nodejs/node/pull/39455
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-09-04 15:14:39 +02:00
Rich Trott d17afa08bd doc: remove _Addenda_ from headers
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-09-04 15:14:32 +02:00
Gireesh Punathil 1e5aca550c inspector: mark as stable
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-09-04 15:14:31 +02:00
Rich Trott a3dee70f66 doc: fix broken internal link in http.md
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-09-04 15:14:31 +02:00
legendecas 1a6bf1c4a3 process: add api to enable source-maps programmatically
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-09-04 15:14:27 +02:00
Michael Dawson 31163ed9ee doc: update Node-api version matrix
- 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-09-04 12:44:14 +02:00
Michael Dawson 9357547519 doc: update node-api support matrix
Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: https://github.com/nodejs/node/pull/38424
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-09-04 12:43:52 +02:00
Rich Trott 9c7c44781c doc: use more consistent formatting for deprecations
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-09-04 12:32:45 +02:00
Rich Trott c4a3a24848 doc: use "pull request" instead of "PR" in packages.md
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-09-04 12:32:35 +02:00
Rich Trott 0d098bfaf0 doc: move v8.stopCoverage() to expected location in doc
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-09-04 12:32:29 +02:00
Rich Trott bd6af78749 doc: move vm.measureMemory() to expected location in doc
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-09-04 12:31:04 +02:00
Rich Trott d56e8268f9 doc,lib: prepare for stricter multi-line array linting
We're about to turn on a requirement for dangling commas.

PR-URL: https://github.com/nodejs/node/pull/37088
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-09-04 12:24:57 +02:00
cjihrig 7378b84bb8 doc: add missing deprecation code
PR-URL: https://github.com/nodejs/node/pull/37147
Refs: https://github.com/nodejs/node/pull/36918
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-09-04 12:24:56 +02:00
Guy Bedford e73bfed2f4 esm: deprecate legacy main lookup for modules
PR-URL: https://github.com/nodejs/node/pull/36918
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-09-04 12:24:56 +02:00
Antoine du Hamel 2f6861ca51 doc: use ASCII order for md refs
PR-URL: https://github.com/nodejs/node/pull/39170
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/188
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-09-04 11:45:00 +02:00
Rich Trott d6a4f8aac9 doc: fix broken link in errors.md
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-09-04 11:33:03 +02:00
legendecas 82458b30fe doc: correct JavaScript primitive value names in n-api.md
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>
2021-09-04 11:31:45 +02:00
Rohan Sharma 74ba115ab6 doc: fix EventTarget.dispatchEvent docs
PR-URL: https://github.com/nodejs/node/pull/39127
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-09-04 11:26:01 +02:00
Davidson Francis d069c725b1 doc: fix napi_default_property name
Fix the napi_default_jsproperty flag of the napi_property_attributes
enum that was incorrectly referred to as napi_default_property.

Signed-off-by: Davidson Francis <davidsondfgl@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/39104
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
2021-09-04 11:19:56 +02:00
Michaël Zasso 1b74d3f775 doc: fix dead links in packages.md
PR-URL: https://github.com/nodejs/node/pull/39113
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-09-04 11:18:15 +02:00
Mao WtmandAntoine du Hamel 0c2b5a048d doc: clearify that http does chunked encoding itself
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/28379
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2021-09-04 11:17:40 +02:00
Nitzan Uziely 526e6c7bde readline: add AbortSignal support to interface
Add abort signal support to Interface

PR-URL: https://github.com/nodejs/node/pull/37932
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-09-04 11:15:51 +02:00
Mattias Runge-Broberg e6eee08692 readline: add support for the AbortController to the question method
In some cases a question asked needs to be canceled. For instance
it might be desirable to cancel a question when a user presses
ctrl+c and triggers the SIGINT event.
Also an initial empty string was set for this.line since the
cursor methods fail if line is not initialized.
Added custom promisify support to the question method.

PR-URL: https://github.com/nodejs/node/pull/33676
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2021-09-04 11:05:07 +02:00
James M Snell 3a60de0135 assert: change status of legacy asserts
Previously marked deprecated, but these are unlikely to ever see
breaking changes or complete removal. Mark as legacy instead.

Signed-off-by: James M Snell <jasnell@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/38113
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2021-09-04 10:43:49 +02:00
Ray d0d731e271 doc: add descriptions about when options.mode is ignored
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-04 10:37:27 +02:00
Juan José Arboleda 898db5a570 doc: add code example to fs.truncate method
PR-URL: https://github.com/nodejs/node/pull/39454
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-09-04 10:36:41 +02:00
Jacob 05d7460747 doc: add annotation to writeFile data as Object
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-09-04 10:35:45 +02:00
Cyrille Bourgois 2ef61b987d doc: fix constants usage in fs.access example
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-09-04 10:34:58 +02:00
Rich Trott b2c533ea1d doc: remove unnecessary module format comments
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-09-04 10:34:47 +02:00
Antoine du Hamel e8355c47d2 doc: remove file name from self-reference links
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/188

PR-URL: https://github.com/nodejs/node/pull/39165
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Harshitha K P <harshitha014@gmail.com>
2021-09-04 10:34:33 +02:00
Antoine du Hamel 6fdac38f91 doc,fs: remove experimental status for WHATWG URL as path
PR-URL: https://github.com/nodejs/node/pull/38870
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
2021-09-04 10:33:25 +02:00
RA80533 f799c4617e doc: use await in filehandle.truncate() snippet
The example snippet of filehandle.close() uses the `await` keyword
based on convention. This change updates the example snippet of
filehandle.truncate() to similarly use the keyword for the purposes of
consistency.

PR-URL: https://github.com/nodejs/node/pull/38939
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
2021-09-04 10:33:15 +02:00
Moritz Kneilmann e7f3f0d778 doc: update abort signal in fs promise api example
PR-URL: https://github.com/nodejs/node/pull/38669
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
2021-09-04 10:32:45 +02:00
Hitesh Sharma a44219d979 doc: add documentation for fs.WriteStream.close()
PR-URL: https://github.com/nodejs/node/pull/38610
Fixes: https://github.com/nodejs/node/issues/38606
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-09-04 10:32:36 +02:00
Luigi Pinca c3ae1cfbab doc: fix fs.openSync() signature
The `mode` argument depends on the `flags` argument but it is optional
even if the `flags` argument is specified.

PR-URL: https://github.com/nodejs/node/pull/38591
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2021-09-04 10:32:20 +02:00
Bryan Field 23a8aed3f9 doc: typo stats() should be stat(); clarity
PR-URL: https://github.com/nodejs/node/pull/38541
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-09-04 10:32:07 +02:00
Rich Trott 9fe46ea0fd doc: fix broken AHAFS link in fs doc
The content we're linking to for AHAFS was published in 2011 but has now
been archived. This updates the link to the archived version (as the
current version results in a "Yikes!" page with an HTTP 400 response
code).

Unfortunately, the archived version does say "This content is no
longer being updated or maintained. The content is provided “as is.”
Given the rapid evolution of technology, some content, steps, or
illustrations may have changed." So we'll want to update at some point I
imagine. But for the moment, archived content with a notice like that is
better than a broken link.

PR-URL: https://github.com/nodejs/node/pull/38534
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Ash Cripps <acripps@redhat.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
2021-09-04 10:31:29 +02:00
James M Snell 7a92c3cfd4 doc: clarify that fs.Dir async iterator closes automatically
Signed-off-by: James M Snell <jasnell@gmail.com>
Fixes: https://github.com/nodejs/node/issues/35148

PR-URL: https://github.com/nodejs/node/pull/38438
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
2021-09-04 10:30:33 +02:00
Michael Rommel b819848487 doc: remove superfluous await from fsPromises.readdir example
The `await` operator in the example, iterating over the returned array
of filenames is not necessary, since the returned array is either
consisting of `string`s or of `fs.Dirent` objects, neither providing
an asyncIterator.

Refs: https://github.com/nodejs/help/issues/3317

PR-URL: https://github.com/nodejs/node/pull/38293
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2021-09-04 10:30:11 +02:00
Siddharth 9fa7dcf9df doc: fix missing backtick in fs.md
PR-URL: https://github.com/nodejs/node/pull/38260
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Nitzan Uziely <linkgoron@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-09-04 10:30:01 +02:00
Michaël Zasso ee1d13c90d fs: use byteLength to handle ArrayBuffer views
Unlike TypedArray, DataView doesn't have a length property.

PR-URL: https://github.com/nodejs/node/pull/38187
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-09-04 10:28:28 +02:00