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
AgeCommit message (Collapse)Author
2021-03-032021-03-03, Version 15.11.0 (Current)v15.11.0Michaël Zasso
Notable changes: crypto: * (SEMVER-MINOR) make FIPS related options always awailable (Vít Ondruch) https://github.com/nodejs/node/pull/36341 errors: * (SEMVER-MINOR) remove experimental from --enable-source-maps (Benjamin Coe) https://github.com/nodejs/node/pull/37362 PR-URL: https://github.com/nodejs/node/pull/37569
2021-03-02doc: remove experimental from --enable-source-mapscjihrig
PR-URL: https://github.com/nodejs/node/pull/37540 Refs: https://github.com/nodejs/node/pull/37362 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-03-02doc: fix typo in doc/api/packages.mdmarsonya
PR-URL: https://github.com/nodejs/node/pull/37536 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
2021-03-02workers: fix spawning from preload scriptsJames M Snell
Fix spawning nested worker threads from preload scripts and warn about doing so. Signed-off-by: James M Snell <jasnell@gmail.com> Fixes: https://github.com/nodejs/node/issues/36531 PR-URL: https://github.com/nodejs/node/pull/37481 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2021-03-02doc: fix typo "director" instead of "directory"humanwebpl
Change fs.readdirSync() description from "Reads the contents of the director." to "Reads the contents of the directory." PR-URL: https://github.com/nodejs/node/pull/37523 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-03-02doc: revise LTS text in collaborator guideRich Trott
PR -> pull request can -> might (to be clear it's about possibility) were -> do for active/passive parallel structure PR-URL: https://github.com/nodejs/node/pull/37527 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
2021-03-02doc: revise CI text in collaborator guideRich Trott
Minor clarifications to text. For example, this moves the "(green or yellow)" parenthetical closer to the text to which it applies. (It applies only to Jenkins CI.) PR-URL: https://github.com/nodejs/node/pull/37526 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Beth Griggs <bgriggs@redhat.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
2021-03-02doc: revise objections section of collaborator guideRich Trott
The bold text is overused in this section. This change removes it. It also changes some wording: PR -> pull request, can -> may in a rare instance where "may" is the right choice in our docs, etc. (The recommendation to avoid "may" is because "may" implies permission rather than just ability. Yes, I'm probably the one that changed it from "may" in the first place.) PR-URL: https://github.com/nodejs/node/pull/37525 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
2021-03-02doc: revise premature disclosure text in collaborator guideRich Trott
Avoid abbreviations and jargon. PR -> pull request, repo -> repository, etc. PR-URL: https://github.com/nodejs/node/pull/37524 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2021-02-28doc: apply sentence case to headers in doc/guidesmarsonya
PR-URL: https://github.com/nodejs/node/pull/37506 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Pooja D P <Pooja.D.P@ibm.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-02-28doc: fix typo in webcrypto.mdmarsonya
PR-URL: https://github.com/nodejs/node/pull/37507 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Pooja D P <Pooja.D.P@ibm.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-02-28child_process: fix spawn and fork abort behaviorNitzan Uziely
Fix AbortSignal in Spawn which doesn't actually abort the process, and fork can emit an AbortError even if the process was already exited. Add documentation For killSignal. Fixes: https://github.com/nodejs/node/issues/37273 PR-URL: https://github.com/nodejs/node/pull/37325 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2021-02-28doc: document the NO_COLOR and FORCE_COLOR env varsJames M Snell
Signed-off-by: James M Snell <jasnell@gmail.com> Fixes: https://github.com/nodejs/node/issues/37404 PR-URL: https://github.com/nodejs/node/pull/37477 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
2021-02-28doc: add url.resolve replacement exampleAntoine du Hamel
Fixes: https://github.com/nodejs/node/issues/37492 PR-URL: https://github.com/nodejs/node/pull/37501 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-02-28doc: apply sentence case to guides headersmarsonya
PR-URL: https://github.com/nodejs/node/pull/37497 Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Pooja D P <Pooja.D.P@ibm.com>
2021-02-28stream: add AbortSignal support to finishedNitzan Uziely
PR-URL: https://github.com/nodejs/node/pull/37354 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-02-28doc: update CI requirements for landing pull requestsAntoine du Hamel
PR-URL: https://github.com/nodejs/node/pull/37308 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com> Reviewed-By: Anatoli Papirovski <apapirovski@mac.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Mary Marchini <oss@mmarchini.me> Reviewed-By: Beth Griggs <bgriggs@redhat.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
2021-02-28crypto: check ed/x webcrypto key import algorithm namesFilip Skokan
PR-URL: https://github.com/nodejs/node/pull/37305 Reviewed-By: James M Snell <jasnell@gmail.com>
2021-02-28crypto: make FIPS related options always awailableVít Ondruch
There is no reason to hide FIPS functionality behind build flags. OpenSSL always provide the information about FIPS availability via `FIPS_mode()` function. This makes the user experience more consistent, because the OpenSSL library is always queried and the `crypto.getFips()` always returns OpenSSL settings. Fixes #34903 PR-URL: https://github.com/nodejs/node/pull/36341 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
2021-02-28fs: fixup negative length in fs.truncateJames M Snell
`fs.ftruncate`, `fsPromises.truncate`, and `fsPromises.ftruncate` all adjust negative lengths to 0 before invoking the system call. `fs.truncate()` was the one outlier. This "fixes" https://github.com/nodejs/node/issues/35632 but in the opposite direction than discussed in the issue -- specifically by removing an EINVAL error from one function rather than adding it to another. Signed-off-by: James M Snell <jasnell@gmail.com> Fixes: https://github.com/nodejs/node/issues/35632 PR-URL: https://github.com/nodejs/node/pull/37483 Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-02-28doc: recommend queueMicrotask over process.nextTickJames M Snell
We likely cannot ever deprecate process.nextTick, but we can start steering people towards queueMicrotask for most cases. Signed-off-by: James M Snell <jasnell@gmail.com> Fixes: https://github.com/nodejs/node/issues/36870 PR-URL: https://github.com/nodejs/node/pull/37484 Reviewed-By: Gus Caplan <me@gus.host> Reviewed-By: Robert Nagy <ronagy@icloud.com>
2021-02-28doc: apply sentence case to headers in doc/guidesmarsonya
PR-URL: https://github.com/nodejs/node/pull/37478 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-02-28doc: fix typo in doc/api/http2/mdmarsonya
PR-URL: https://github.com/nodejs/node/pull/37479 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-02-28errors: remove experimental from --enable-source-mapsbcoe
PR-URL: https://github.com/nodejs/node/pull/37362 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Ian Sutherland <ian@iansutherland.ca> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Beth Griggs <bgriggs@redhat.com>
2021-02-28doc: alphabetize vm Module class propertiesRich Trott
PR-URL: https://github.com/nodejs/node/pull/37451 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-02-28doc: alphabetize crypto Cipher class entriesRich Trott
PR-URL: https://github.com/nodejs/node/pull/37450 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-02-28doc: use HEAD for links in api docsMichael Dawson
Change links in api docs to use HEAD when they refer to the primary branch. Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: https://github.com/nodejs/node/pull/37437 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
2021-02-28doc: fix alignment of parametersMichael Dawson
fix alignment of parameters in napi_fatal_error Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: https://github.com/nodejs/node/pull/37422 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-02-28doc: fix typo in doc/api/esm.mdmarsonya
PR-URL: https://github.com/nodejs/node/pull/37400 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Pooja D P <Pooja.D.P@ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
2021-02-28doc: fix "referred to" in fs docsTobias Nießen
PR-URL: https://github.com/nodejs/node/pull/37388 Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Pooja D P <Pooja.D.P@ibm.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-02-28doc: document x509 error codesDan Čermák
Signed-off-by: Dan Čermák <dcermak@suse.com> Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com> Co-authored-by: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/nodejs/node/pull/37096 Fixes: https://github.com/nodejs/node/issues/29342 Fixes: https://github.com/nodejs/node/issues/29342 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
2021-02-28doc,child_process: `pid` can be `undefined` when `ENOENT`dr-js
From the code `nodejs@8` and up should behave the same: github.com/nodejs/node/blame/v8.17.0/lib/internal/child_process.js#L290 And a short test snippet: ```js const { spawn } = require('child_process') const subProcess = spawn('non-exist-command') subProcess.on('error', (error) => console.warn('mute Unhandled "error" event:', error)) console.log('- pid:', subProcess.pid) process.nextTick(() => console.log('- after error emit')) console.log('== end of test ==') ``` Note: the sync spawn result `pid` currently do not follow this pattern. Co-authored-by: Rich Trott <rtrott@gmail.com> PR-URL: https://github.com/nodejs/node/pull/37014 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
2021-02-28doc: fix typo in esm.mdJay Tailor
I presume "The can..." should be "They can...". PR-URL: https://github.com/nodejs/node/pull/37417 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Pooja D P <Pooja.D.P@ibm.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-02-28doc: use HEAD in links where possibleMichael Dawson
Where possible used HEAD in links Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: https://github.com/nodejs/node/pull/37421 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
2021-02-28doc,lib: prepare for stricter multi-line array lintingRich Trott
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-02-28stream: add AbortSignal to promisified pipelineNitzan Uziely
add support for AbortSignal to promisified pipeline. Resolves: https://github.com/nodejs/node/issues/37321 PR-URL: https://github.com/nodejs/node/pull/37359 Reviewed-By: Robert Nagy <ronagy@icloud.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com>
2021-02-28doc: clarify that async_hook callbacks cannot be asyncJames M Snell
Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/nodejs/node/pull/37384 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Zijian Liu <lxxyxzj@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
2021-02-28doc: use **Default:** more consistentlycjihrig
It seems that **Default:** was unofficially decided on as the way to specify default values. This commit updates the API documentation to use this format more consistently. PR-URL: https://github.com/nodejs/node/pull/37387 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Pooja D P <Pooja.D.P@ibm.com> Reviewed-By: Darshan Sen <raisinten@gmail.com>
2021-02-222021-02-23, Version 15.10.0 (Current)v15.10.0Beth Griggs
This is a security release. Notable changes: Vulnerabilities fixed: - **CVE-2021-22883**: HTTP2 'unknownProtocol' cause Denial of Service by resource exhaustion - **CVE-2021-22884**: DNS rebinding in --inspect - **CVE-2021-23840**: OpenSSL - Integer overflow in CipherUpdate PR-URL: https://github.com/nodejs-private/node-private/pull/253
2021-02-20http2: add unknownProtocol timeoutDaniel Bevenius
This commit add a configuration options named unknownProtocolTimeout which can be specified to set a value for the timeout in milliseconds that a server should wait when an unknowProtocol is sent to it. When this happens a timer will be started and the if the socket has not been destroyed during that time the timer callback will destoy it. Refs: https://hackerone.com/reports/1043360 CVE-ID: CVE-2021-22883 PR-URL: https://github.com/nodejs-private/node-private/pull/246 Reviewed-By: Beth Griggs <bgriggs@redhat.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de>
2021-02-172021-02-17, Version 15.9.0 (Current)v15.9.0Danielle Adams
PR-URL: https://github.com/nodejs/node/pull/37406 Notable Changes: * crypto: * add keyObject.export() jwk format option (Filip Skokan) https://github.com/nodejs/node/pull/37081 * deps: * upgrade to libuv 1.41.0 (Colin Ihrig) https://github.com/nodejs/node/pull/37360 * doc: * add dmabupt to collaborators (Xu Meng) https://github.com/nodejs/node/pull/37377 * refactor fs docs structure (James M Snell) https://github.com/nodejs/node/pull/37170 * fs: * add fsPromises.watch() (James M Snell) https://github.com/nodejs/node/pull/37179 * use a default callback for fs.close() (James M Snell) https://github.com/nodejs/node/pull/37174 * add AbortSignal support to watch (Benjamin Gruenbaum) https://github.com/nodejs/node/pull/37190 * perf_hooks: * introduce createHistogram (James M Snell) https://github.com/nodejs/node/pull/37155 * stream: * improve Readable.from error handling (Benjamin Gruenbaum) https://github.com/nodejs/node/pull/37158 * timers: * introduce setInterval async iterator (linkgoron) https://github.com/nodejs/node/pull/37153 * tls: * add ability to get cert/peer cert as X509Certificate object (James M Snell) https://github.com/nodejs/node/pull/37070
2021-02-16fs: add fsPromises.watch()James M Snell
An alternative to `fs.watch()` that returns an `AsyncIterator` ```js const { watch } = require('fs/promises'); (async () => { const ac = new AbortController(); const { signal } = ac; setTimeout(() => ac.abort(), 10000); const watcher = watch('file.txt', { signal }); for await (const { eventType, filename } of watcher) { console.log(eventType, filename); } })() ``` Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: https://github.com/nodejs/node/pull/37179 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
2021-02-16doc: optimize HTML renderingAntoine du Hamel
Defer rendering sections of docs until they are displayed on the user's screen. PR-URL: https://github.com/nodejs/node/pull/37301 Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-02-16doc: fix quotes in stream docsTobias Nießen
PR-URL: https://github.com/nodejs/node/pull/37269 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Beth Griggs <bgriggs@redhat.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
2021-02-16doc: fix backticks in crypto API docsTobias Nießen
PR-URL: https://github.com/nodejs/node/pull/37269 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Beth Griggs <bgriggs@redhat.com> Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
2021-02-16doc: link PACKAGE_EXPORTS_RESOLVE to ESM sectionUtku Gultopu
Linked PACKAGE_EXPORTS_RESOLVE to "Resolver Algorithm Specification" in "ECMAScript modules" page, so that the `require` pseudocode is easier to understand. PR-URL: https://github.com/nodejs/node/pull/37135 Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-02-16doc: alphabetize crypto.* methodsRich Trott
The list of methods on the `crypto` object is almost in alphabetical order but not quite. This change alphabetizes the methods. PR-URL: https://github.com/nodejs/node/pull/37353 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: Luigi Pinca <luigipinca@gmail.com>
2021-02-16doc: use sentence case in benchmark docRich Trott
Apply sentence case consistently in headers in benchmark doc. PR-URL: https://github.com/nodejs/node/pull/37351 Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-02-16doc: apply sentence-consistently in C++ style guideRich Trott
Use sentence case for headers consistently. This makes the document internally consistent and also aligns it with our docs generally and the style guide we use for docs. PR-URL: https://github.com/nodejs/node/pull/37350 Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2021-02-16doc: apply sentence case to release doc headersRich Trott
Our style is to use sentence case for headers and documentation titles. The documentation for releases uses both sentence case and title case. This change applies sentence case consistently throughout. PR-URL: https://github.com/nodejs/node/pull/37349 Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>