Beth Griggs
218381213b
doc: sync deprecation numbers with v14.x
...
Syncs master and v14.x for DEP0143 - `Transform._transformState`.
Bumps `module.parent` from DEP0143 to DEP0144 on master. Adds
missing DEP number and metadata for DEP0145: `socket.bufferSize`.
PR-URL: https://github.com/nodejs/node/pull/34368
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Richard Lau <riclau@uk.ibm.com >
Reviewed-By: Myles Borins <myles.borins@gmail.com >
2020-07-15 11:37:37 -04:00
Guy Bedford
e212955e8a
doc: clarify conditional exports guidance
...
PR-URL: https://github.com/nodejs/node/pull/34306
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Jan Krems <jan.krems@gmail.com >
2020-07-14 08:04:49 -07:00
Anna Henningsen
a038199265
src,doc,test: remove String::New default parameter
...
`kNormal` has been the implicit default for a while now (since V8 7.6).
Refs: https://github.com/v8/v8/commit/e0d7f816990ada28ebe1281ca9431236ef8c6e4f
PR-URL: https://github.com/nodejs/node/pull/34248
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-14 15:13:34 +02:00
James M Snell
f1dc5cd614
doc: buffer documentation improvements
...
PR-URL: https://github.com/nodejs/node/pull/34230
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-07-14 15:11:31 +02:00
Anna Henningsen
725cf4764a
worker: add option to track unmanaged file descriptors
...
Add a public option for Workers which adds tracking for raw
file descriptors, as currently, those resources are not cleaned
up, unlike e.g. `FileHandle`s.
PR-URL: https://github.com/nodejs/node/pull/34303
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
2020-07-14 15:07:20 +02:00
Rich Trott
f902170af6
doc: improve text in fs docs about omitting callbacks
...
Repair misplaced colon and condense text.
PR-URL: https://github.com/nodejs/node/pull/34307
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-13 15:35:39 -07:00
Mateusz Krawczuk
2e6c3e2301
tls: make 'createSecureContext' honor more options
...
Added options: `ticketKeys` and `sessionTimeout`, that are honored by
`createServer`, that calls `createSecureContext`.
This also introduces a minor code simplification.
PR-URL: https://github.com/nodejs/node/pull/33974
Fixes: https://github.com/nodejs/node/issues/20908
Reviewed-By: Alba Mendez <me@alba.sh >
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org >
2020-07-13 10:48:32 +02:00
Rich Trott
ac6ecd6b7f
doc: reword warnings about sockets passed to subprocesses
...
Make the docs more concise. Make warnings direct ("do not use" and
"should") rather than "is not recommended" or "is recommended".
PR-URL: https://github.com/nodejs/node/pull/34273
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2020-07-11 21:03:03 -07:00
James M Snell
48a349efd9
quic: use Number instead of BigInt for more stats
...
PR-URL: https://github.com/nodejs/node/pull/34262
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-07-10 13:51:16 -07:00
James M Snell
5e769b2eaf
quic: use less specific error codes
...
Stop the madness. Only you can prevent excessive error code
proliferation.
PR-URL: https://github.com/nodejs/node/pull/34262
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-07-10 13:51:13 -07:00
Guy Bedford
1237955d41
module: package "imports" field
...
PR-URL: https://github.com/nodejs/node/pull/34117
Reviewed-By: Jan Krems <jan.krems@gmail.com >
Reviewed-By: Bradley Farias <bradley.meck@gmail.com >
2020-07-09 19:19:35 -07:00
James M Snell
99f0404646
doc: specify encoding in text/html examples
...
Fixes: https://github.com/nodejs/node/issues/29739
PR-URL: https://github.com/nodejs/node/pull/34222
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
2020-07-09 08:49:50 -07:00
James M Snell
f98a441bf7
doc: document the ready event for Http2Stream
...
Fixes: https://github.com/nodejs/node/issues/22804
PR-URL: https://github.com/nodejs/node/pull/34221
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2020-07-09 07:36:34 -07:00
James M Snell
a720c0edcc
doc: add comment to example about 2xx status codes
...
Fixes: https://github.com/nodejs/node/issues/29714
PR-URL: https://github.com/nodejs/node/pull/34223
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2020-07-09 07:35:37 -07:00
James M Snell
14ac6e4226
doc: document that whitespace is ignored in base64 decoding
...
Fixes: https://github.com/nodejs/node/issues/8569
PR-URL: https://github.com/nodejs/node/pull/34227
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2020-07-09 07:34:30 -07:00
James M Snell
62bdb7e801
doc: add note about multiple sync events and once
...
Fixes: https://github.com/nodejs/node/issues/32431
PR-URL: https://github.com/nodejs/node/pull/34220
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2020-07-09 07:31:54 -07:00
James M Snell
949d1c1f0c
doc: document behavior for once(ee, 'error')
...
Fixes: https://github.com/nodejs/node/issues/31244
PR-URL: https://github.com/nodejs/node/pull/34225
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-07-09 07:25:08 -07:00
James M Snell
a95fb930d0
doc: document security issues with url.parse()
...
Fixes: https://github.com/nodejs/node/issues/31279
PR-URL: https://github.com/nodejs/node/pull/34226
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2020-07-09 07:21:04 -07:00
James M Snell
fe11f6bf7c
quic: cleanup QuicSocketFlags, used shared state struct
...
Some of the flags were no longer being used.
Switched to use an AliasedStruct for shared state to avoid
extraneous expensive JS=>C++ calls.
Removed unused QuicSocket option
PR-URL: https://github.com/nodejs/node/pull/34247
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-07-09 07:15:43 -07:00
James M Snell
71236097d0
quic: use Number() instead of bigint for QuicSocket stats
...
PR-URL: https://github.com/nodejs/node/pull/34247
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-07-09 07:14:17 -07:00
James M Snell
94372b124a
quic: refactor/improve/document QuicSocket listening event
...
PR-URL: https://github.com/nodejs/node/pull/34247
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-07-09 07:14:14 -07:00
James M Snell
cc89aac5f7
quic: refactor/improve error handling for busy event
...
Also, change setServerBusy into a setter
PR-URL: https://github.com/nodejs/node/pull/34247
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-07-09 07:14:07 -07:00
James M Snell
edc71ef008
quic: handle errors thrown / rejections in the session event
...
Errors thrown within the session event handler will be handled
by destroying the session (allowing a proper connection close
to be sent to the client peer). They will not crash the parent
QuicSocket by default. Instead, a `'sessionError'` event will
be emitted, allowing the error to be logged or handled.
PR-URL: https://github.com/nodejs/node/pull/34247
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-07-09 07:14:05 -07:00
rickyes
527e2147af
stream: add promises version to utility functions
...
PR-URL: https://github.com/nodejs/node/pull/33991
Fixes: https://github.com/nodejs/node/issues/33582
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Denys Otrishko <shishugi@gmail.com >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Robert Nagy <ronagy@icloud.com >
2020-07-09 09:12:19 +02:00
sapics
3975799f26
doc: replace http to https of link urls
...
PR-URL: https://github.com/nodejs/node/pull/34158
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-06 07:03:05 -07:00
Rich Trott
bf772896fe
doc: remove errors that were never released
...
Refs: https://github.com/nodejs/node/pull/33764#issuecomment-653667275
PR-URL: https://github.com/nodejs/node/pull/34197
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-06 07:02:17 -07:00
Rich Trott
654df09ae0
doc: move ERR_FEATURE_UNAVAILABLE_ON_PLATFORM to current errors
...
ERR_FEATURE_UNAVAILABLE_ON_PLATFORM is incorrectly included in the list
of errors that have never been released. It was added in
67e067eb06 and included in every release
in the 14.x line.
PR-URL: https://github.com/nodejs/node/pull/34196
Reviewed-By: Richard Lau <riclau@uk.ibm.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2020-07-05 15:05:43 -07:00
James M Snell and zombieleet
e7dadd376e
doc: specify how fs.WriteStream/ReadStreams are created
...
Alternative to https://github.com/nodejs/node/pull/33841
Co-authored-by: zombieleet <zombieleetnca@gmail.com >
PR-URL: https://github.com/nodejs/node/pull/34188
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2020-07-05 14:19:42 -07:00
James M Snell
7b062ca015
quic: refactor qlog handling
...
Because of the timing of qlog events emitted by ngtcp2, it
becomes difficult to handle those as events on the QuicSession
object because the final qlog entry is not emitted until the
ngtcp2_conn is freed, which can occur when the object is being
garbage collected (meaning, we a: can't call out to javascript
and b: don't have an object we can use to emit the event).
This refactors it into a QLogStream object that allows the
qlog data to be piped out using a separate Readable stream.
PR-URL: https://github.com/nodejs/node/pull/34160
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-07-05 14:17:33 -07:00
Rich Trott
56dbe466fd
doc: remove parenthetical \r\n comment in http and http2 docs
...
The explanation that the HTTP requests include `\r\n` is true but not
important or relevant in these two specific contexts.
PR-URL: https://github.com/nodejs/node/pull/34178
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com >
2020-07-04 16:46:26 -07:00
Rich Trott
21005c3b44
doc: remove stability from unreleased errors
...
Remove stability indicators from errors that only existed on the master
branch and are not in the release.
PR-URL: https://github.com/nodejs/node/pull/33764
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-07-04 05:51:42 -07:00
Bradley Farias
16f3b6a01b
doc: util.debuglog callback
...
PR-URL: https://github.com/nodejs/node/pull/33856
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-03 15:01:10 -07:00
Julien Poissonnier
647babc2fd
doc: update wording in "Two reading modes"
...
PR-URL: https://github.com/nodejs/node/pull/34119
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: Zeyu Yang <himself65@outlook.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-03 14:53:17 -07:00
Luigi Pinca
d2c8b3efc3
doc: clarify that the ctx argument is optional
...
Clarify that the `ctx` argument of the `SNICallback` callback is
optional.
Fixes: https://github.com/nodejs/node/issues/34085
PR-URL: https://github.com/nodejs/node/pull/34097
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org >
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-03 14:49:30 -07:00
Mateusz Krawczuk
d3d4aceb96
doc: add a reference to the list of OpenSSL flags.
...
Some of the SSL_OP_* constants are missing description in the
documentation. Instead of rewriting the description from OpenSSL's
wiki, I have decided to put a link to a detailed list in the
'OpenSSL Options' section.
I see no point of doing both - adding a reference to the wiki and
adding constant descriptions - but I might do if presented with
convincing arguments.
This is a follow-up to #33929 .
PR-URL: https://github.com/nodejs/node/pull/34050
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-03 14:44:21 -07:00
Saleem
1a9d6316b8
doc: use consistent naming in stream doc
...
Consistency of method naming
referred to as readable.push several other times in transform
documentation and also documented under readable, so makes sense
to just stick with readable.push
PR-URL: https://github.com/nodejs/node/pull/30506
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-03 14:28:22 -07:00
Anentropic
7c9df66485
doc: clarify how to read process.stdin
...
document more clearly that stdin will emit multiple readable events
PR-URL: https://github.com/nodejs/node/pull/27350
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Robert Nagy <ronagy@icloud.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-03 14:05:47 -07:00
Gabriel Schulhof
cfa3d8fec5
doc: fix entry for napi_create_external_buffer
...
Remove text regarding copying, because `napi_create_external_buffer`
does not copy.
Fixes: https://github.com/nodejs/node/issues/33471
PR-URL: https://github.com/nodejs/node/pull/34125
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Mathias Buus <mathiasbuus@gmail.com >
Reviewed-By: Zeyu Yang <himself65@outlook.com >
Reviewed-By: Chengzhong Wu <legendecas@gmail.com >
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-03 13:57:50 -07:00
Denys Otrishko
b4fe76d656
doc: improve async_hooks asynchronous context example
...
* use writeFile(1) everywhere to log
* prettify execution id graph
* add clearer explanation for TickObject presence
* add causation graph via triggerAsyncId
PR-URL: https://github.com/nodejs/node/pull/33730
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de >
Reviewed-By: Andrey Pechkurov <apechkurov@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com >
2020-07-03 13:24:39 -07:00
Derek Lewis
db3b209e7d
doc: clarify esm conditional exports prose
...
This commit clarifies the behavior of a couple aspects of
conditional exports that may have been difficult to grasp
from the prose alone.
PR-URL: https://github.com/nodejs/node/pull/33886
Reviewed-By: Guy Bedford <guybedford@gmail.com >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-03 12:16:23 -07:00
rickyes
a7c6806adc
doc: Add maxTotalSockets option to agent constructor
...
PR-URL: https://github.com/nodejs/node/pull/34013
Refs: https://github.com/nodejs/node/pull/33617
Reviewed-By: Robert Nagy <ronagy@icloud.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-03 12:14:03 -07:00
rickyes
7f2cf0f8da
doc: add streams to the pipeline function signature
...
PR-URL: https://github.com/nodejs/node/pull/34153
Reviewed-By: Robert Nagy <ronagy@icloud.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-03 12:11:48 -07:00
Rich Trott
907829b1a4
doc: simply dns.ADDRCONFIG language
...
PR-URL: https://github.com/nodejs/node/pull/34155
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-07-03 12:03:37 -07:00
Rich Trott
829f521fda
doc: remove "considered" in errors.md
...
"would be considered a `TypeError`" -> "would be a `TypeError`".
Using "considered" introduces unnecessary ambiguity. Is is not actually
a TypeError but merely "considered" one? Why is that? We don't say.
Simplify to "is a TypeError".
PR-URL: https://github.com/nodejs/node/pull/34152
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Christian Clauss <cclauss@me.com >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de >
Reviewed-By: Andrey Pechkurov <apechkurov@gmail.com >
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
2020-07-03 07:35:58 -07:00
Rich Trott
dfeeb3c275
doc: simplify and clarify ReferenceError material in errors.md
...
"should always be considered" -> "indicate"
PR-URL: https://github.com/nodejs/node/pull/34151
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com >
Reviewed-By: Christian Clauss <cclauss@me.com >
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de >
Reviewed-By: Chengzhong Wu <legendecas@gmail.com >
Reviewed-By: Andrey Pechkurov <apechkurov@gmail.com >
2020-07-03 07:33:29 -07:00
Derek Lewis
1dc837ed9a
doc: add http highlight grammar
...
Prior to this commit, http request message code blocks in Markdown
files were not being highlighted correctly. This has been corrected by
adding the new grammar to the bundle, removing the CRLFs (`\r\n`) from
these code samples, adding a reminder to re-add them, and tuning the
syntax theme to support attribute highlighting.
PR-URL: https://github.com/nodejs/node/pull/33785
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
2020-07-02 16:32:42 -07:00
Rich Trott
f06df175b4
doc: change "considered experimental" to "experimental" in n-api.md
...
This changes "considered" experimental" to "experimental" in the
n-api.md file and introduces some additional brevity.
PR-URL: https://github.com/nodejs/node/pull/34129
Reviewed-By: Denys Otrishko <shishugi@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2020-07-02 05:37:25 -07:00
Rich Trott
79eb529c3e
doc: changed "considered experimental" to "experimental" in cli.md
...
Change "no longer considered experimental" to "no longer experimental"
in cli.md.
PR-URL: https://github.com/nodejs/node/pull/34128
Reviewed-By: Denys Otrishko <shishugi@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2020-07-02 05:35:57 -07:00
Robert Nagy
c7e55c6b72
stream: fix writable.end callback behavior
...
Changes so that the end() callback behaves the same way in relation
to _final as write() does to _write/_writev.
PR-URL: https://github.com/nodejs/node/pull/34101
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-07-01 18:18:04 +02:00
Rich Trott
e2b468eb5c
doc: change "currently not considered public" to "not supported"
...
PR-URL: https://github.com/nodejs/node/pull/34114
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-06-30 21:56:11 -07:00