Antoine du Hamel
0177d4cc20
doc: optimize HTML rendering
...
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-15 16:14:15 +01:00
James M Snell
4a19cc8947
perf_hooks: introduce createHistogram
...
Adds a new `perf_hooks.createHistogram()` API for creating histogram
instances that allow user recording.
Makes Histogram instances cloneable via MessagePort. This allows, for
instance, an event loop delay monitor to be running on the main thread
while the histogram data can be monitored actively from a worker thread.
Signed-off-by: James M Snell <jasnell@gmail.com >
PR-URL: https://github.com/nodejs/node/pull/37155
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
2021-02-14 13:03:49 -08:00
Michaël Zasso
5bf2737e13
tools: avoid pending deprecation in doc generator
...
`unist-util-find` depends on `lodash.iteratee` which uses
`process.binding()`.
Let's remove this dependency which is used in one place to do a very
simple thing.
PR-URL: https://github.com/nodejs/node/pull/37267
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
Reviewed-By: Richard Lau <rlau@redhat.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Darshan Sen <raisinten@gmail.com >
2021-02-12 21:46:54 +01:00
Rich Trott
683754c6f3
doc: remove TOC summary for pages with no TOC
...
Remove the table of contents summary for pages with no table of
contents. Currently, this affects at least index.html.
PR-URL: https://github.com/nodejs/node/pull/37043
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
2021-01-31 06:03:33 -08:00
James M Snell
c3d6d50309
quic: remove quic
...
PR-URL: https://github.com/nodejs/node/pull/37067
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Tobias Nießen <tniessen@tnie.de >
Reviewed-By: Michael Dawson <midawson@redhat.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2021-01-30 07:49:28 -08:00
cjihrig
1b222f900e
tools: remove commented code from stability.js
...
PR-URL: https://github.com/nodejs/node/pull/37092
Reviewed-By: Zijian Liu <lxxyxzj@gmail.com >
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com >
Reviewed-By: Richard Lau <rlau@redhat.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2021-01-29 20:05:25 +08:00
Zijian Liu
2bb42bf156
tools,doc: list the stability status of each API
...
Fixes: https://github.com/nodejs/node/issues/23723
PR-URL: https://github.com/nodejs/node/pull/36223
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com >
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Myles Borins <myles.borins@gmail.com >
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
2021-01-20 01:23:45 +01:00
James M Snell
d4bea09a0a
buffer: introduce Blob
...
The `Blob` object is an immutable data buffer. This is a first step
towards alignment with the `Blob` Web API.
Signed-off-by: James M Snell <jasnell@gmail.com >
PR-URL: https://github.com/nodejs/node/pull/36811
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
2021-01-18 13:55:25 -08:00
James M Snell
bd899bc656
crypto: experimental (Ed/X)25519/(Ed/X)448 support
...
Implements initial experimental support for Curve25519 and
Curve448 support for both ECDH and sign/verify in Web Crypto.
Introduced as a Node.js-specific extension to Web Crypto.
Signed-off-by: James M Snell <jasnell@gmail.com >
Fixes: https://github.com/nodejs/node/issues/36076
PR-URL: https://github.com/nodejs/node/pull/36879
Reviewed-By: Filip Skokan <panva.ip@gmail.com >
2021-01-18 08:12:08 -08:00
Mattia Pontonio
2ba8728b9f
doc: wrap TOC in a <details> tag
...
PR-URL: https://github.com/nodejs/node/pull/36896
Fixes: https://github.com/nodejs/node/issues/36885
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
2021-01-14 16:35:59 +01:00
Michaël Zasso
9883fe0114
tools: update doc tool dependencies
...
PR-URL: https://github.com/nodejs/node/pull/36844
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2021-01-11 08:13:23 +01:00
James M Snell
f5287a4b7b
crypto: introduce X509Certificate API
...
Introduces the `crypto.X509Certificate` object.
```js
const { X509Certificate } = require('crypto');
const x509 = new X509Certificate('{pem encoded cert}');
console.log(x509.subject);
```
Fixes: https://github.com/nodejs/node/issues/29181
Signed-off-by: James M Snell <jasnell@gmail.com >
PR-URL: https://github.com/nodejs/node/pull/36804
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Filip Skokan <panva.ip@gmail.com >
2021-01-09 12:04:23 -08:00
Michaël Zasso
8dbeac6c04
tools: update doc tool dependencies
...
PR-URL: https://github.com/nodejs/node/pull/36407
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Myles Borins <myles.borins@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-12-08 22:17:58 +00:00
James M Snell
9e446b3e9f
worker: add experimental BroadcastChannel
...
Signed-off-by: James M Snell <jasnell@gmail.com >
PR-URL: https://github.com/nodejs/node/pull/36271
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
2020-12-01 08:02:28 -08:00
Rich Trott
cb023a3e70
tools: update stability index linking logic
...
Fix logic that prevents stability index text from linking to itself.
PR-URL: https://github.com/nodejs/node/pull/36280
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com >
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
2020-11-30 16:57:48 -08:00
Myles Borins
f34866a61c
tools: update highlight.js to 10.1.2
...
Refs: https://github.com/advisories/GHSA-vfrc-7r7c-w9mx
PR-URL: https://github.com/nodejs/node/pull/36309
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
2020-11-29 20:27:23 -08:00
Rich Trott
6312193391
tools: bump unist-util-find@1.0.1 to unist-util-find@1.0.2
...
PR-URL: https://github.com/nodejs/node/pull/36106
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
2020-11-20 04:55:54 -08:00
Rich Trott
088af0f98b
tools: update doc tools to remark-parse@9.0.0
...
PR-URL: https://github.com/nodejs/node/pull/36049
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com >
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com >
2020-11-12 06:29:51 +00:00
Antoine du Hamel
3c9f072522
tools,doc: enable ecmaVersion 2021 in acorn parser
...
PR-URL: https://github.com/nodejs/node/pull/35994
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Jiawen Geng <technicalcute@gmail.com >
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2020-11-07 01:30:21 +00:00
Stephen Belanger
c6c36c3da7
lib: create diagnostics_channel module
...
PR-URL: https://github.com/nodejs/node/pull/34895
Reviewed-By: Bryan English <bryan@bryanenglish.com >
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de >
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com >
Reviewed-By: Michael Dawson <midawson@redhat.com >
2020-10-31 21:24:11 +00:00
Simen Bekkhus
ee85eb9f8a
doc: importModuleDynamically gets Script, not Module
...
PR-URL: https://github.com/nodejs/node/pull/35593
Reviewed-By: Gus Caplan <me@gus.host >
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
2020-10-17 22:13:22 -07:00
Rich Trott
936ce85c0b
doc: use sentence case for class property
...
Change the one instance of the Class Property heading in our docs to
Class property to match style with other headers.
PR-URL: https://github.com/nodejs/node/pull/35540
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-10-09 06:10:16 -07:00
James M Snell
dae283d96f
crypto: refactoring internals, add WebCrypto
...
Fixes: https://github.com/nodejs/node/issues/678
Refs: https://github.com/nodejs/node/issues/26854
Signed-off-by: James M Snell <jasnell@gmail.com >
PR-URL: https://github.com/nodejs/node/pull/35093
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2020-10-07 17:27:05 -07:00
Antoine du Hamel
6467d1d4e9
tools: fix typo in error message
...
PR-URL: https://github.com/nodejs/node/pull/35417
Reviewed-By: Richard Lau <rlau@redhat.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Zeyu Yang <himself65@outlook.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2020-10-04 11:46:39 +02:00
Rich Trott
e9639ee7e8
tools,doc: fix broken link in module.html
...
Update tools/doc/type-parser.js with correct URL for the
module.SourceMap class. This fixes a broken link in our documentation.
PR-URL: https://github.com/nodejs/node/pull/35446
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Richard Lau <rlau@redhat.com >
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com >
2020-10-03 05:41:50 -07:00
Antoine du Hamel
91837e9fbb
tools: check links in api docs
...
Fixes: https://github.com/nodejs/node/issues/35189
PR-URL: https://github.com/nodejs/node/pull/35191
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is >
Reviewed-By: Jiawen Geng <technicalcute@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Richard Lau <riclau@uk.ibm.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2020-10-01 06:19:42 -07:00
Antoine du Hamel
ecf5060a42
doc: use .md extension for internal links
...
This helps catch broken links as part of the test suite. This also
improves the user experience when browsing the markdown files.
PR-URL: https://github.com/nodejs/node/pull/35191
Fixes: https://github.com/nodejs/node/issues/35189
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is >
Reviewed-By: Jiawen Geng <technicalcute@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
Reviewed-By: Richard Lau <riclau@uk.ibm.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2020-10-01 06:19:12 -07:00
Michaël Zasso
a77f2ea6d4
tools: exclude gyp from markdown link checker
...
The changelog format used in gyp-next does not comply to the rules.
PR-URL: https://github.com/nodejs/node/pull/35423
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org >
Reviewed-By: Jiawen Geng <technicalcute@gmail.com >
Reviewed-By: Richard Lau <riclau@uk.ibm.com >
2020-09-30 17:50:22 +02:00
Ash Cripps
77dd44078e
tools: ignore build folder when checking links
...
We checkout build as a subdirectory as part of CI and
if you run `make test` instead of `make test-ci` you get
loads of errors about markdown link breaks. Ignore this
directory as we don't need to examine another repo
PR-URL: https://github.com/nodejs/node/pull/35315
Reviewed-By: Richard Lau <riclau@uk.ibm.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2020-09-24 10:30:59 +00:00
Antoine du Hamel
7794d36a37
tools,doc: enforce alphabetical order for md refs
...
PR-URL: https://github.com/nodejs/node/pull/35244
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Shelley Vohr <codebytere@gmail.com >
2020-09-22 10:25:43 -07:00
Antoine du Hamel
0b8fdb70ac
tools,doc: upgrade dependencies
...
PR-URL: https://github.com/nodejs/node/pull/35244
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Shelley Vohr <codebytere@gmail.com >
2020-09-22 10:25:36 -07:00
Rich Trott
26e660f962
doc: remove problematic auto-linking of curl man pages
...
The only instance of curl man page linking is in repl.md and it is
explicit. The magic autolinking in html.js creates a superfluous empty
link. Remove it.
Before, two adjacent links generated, with the first one having no text:
```html
<a href="https://curl.haxx.se/docs/manpage.html "></a>
<a href="https://curl.haxx.se/docs/manpage.html "><code>curl(1)</code></a>
```
After, just one link:
```html
<a href="https://curl.haxx.se/docs/manpage.html "><code>curl(1)</code></a>
```
PR-URL: https://github.com/nodejs/node/pull/35174
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Ben Coe <bencoe@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2020-09-15 10:50:09 -07:00
Antoine du HAMEL
fa105ebe7d
doc: refactor deprecation anchors
...
PR-URL: https://github.com/nodejs/node/pull/34955
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2020-09-04 08:40:30 -07:00
Antoine du HAMEL
d2c5e89165
tools,doc: allow page titles to contain inline code
...
Previously the HTML title would be cut to the first text node only.
PR-URL: https://github.com/nodejs/node/pull/35003
Reviewed-By: Richard Lau <riclau@uk.ibm.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is >
2020-09-03 06:36:03 -07:00
Antoine du Hamel
79ea22a531
tools,doc: fix global table of content active element
...
Assign active class to the correct HTML element when one nav-id is a
subset of another one (E.G.: `nav-module` and `nav-modules`).
Fixes: https://github.com/nodejs/node/issues/34975
PR-URL: https://github.com/nodejs/node/pull/34976
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is >
Reviewed-By: Zeyu Yang <himself65@outlook.com >
2020-09-03 04:53:31 -04:00
Rich Trott
cc9ac42111
doc,tools: remove malfunctioning Linux manpage linker
...
The Linux manpage auto-linking is resulting in extraneous
links with empty text in the docs. Remove it as the only thing it
affects is linked explicitly in the one document that uses it.
PR-URL: https://github.com/nodejs/node/pull/34985
Reviewed-By: Michaël Zasso <targos@protonmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Mary Marchini <oss@mmarchini.me >
2020-09-02 07:55:43 -07:00
Rich Trott
4332f73832
tools,doc: remove "toc" anchor name
...
The _name_ attribute is obsolete. Changing it to _id_ in the case of
"toc" would result in a conflict with an existing id. However, there are
no links to "#toc" in our docs. And if there were, it would be more
appropriate to link to the id toc which is the toc for the individual
documents. So remove the anchor name entirely.
PR-URL: https://github.com/nodejs/node/pull/34893
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com >
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com >
2020-08-26 07:31:45 -07:00
Antoine du HAMEL
21abb2545f
doc: move module core module doc to separate page
...
The `module` core module is available for both CJS and ESM users, it
deserves its own page.
PR-URL: https://github.com/nodejs/node/pull/34747
Refs: https://github.com/nodejs/modules/issues/539
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-08-19 10:44:06 -07:00
Richard Lau
9a819ddbac
doc,tools: annotate broken links in actions workflow
...
Change format of logged messages when run on GitHub Actions (i.e.
when the `GITHUB_ACTIONS` environment variable is true) so that
broken links are highlighted inline in pull requests.
Signed-off-by: Richard Lau <riclau@uk.ibm.com >
PR-URL: https://github.com/nodejs/node/pull/34810
Refs: https://github.com/nodejs/node/issues/34787
Reviewed-By: Mary Marchini <oss@mmarchini.me >
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Jiawen Geng <technicalcute@gmail.com >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2020-08-19 10:42:36 -07:00
James M Snell
1c14810edc
src: allow instances of net.BlockList to be created internally
...
Initial PR had it so that user code would create BlockList
instances. This sets it up so that instances can be created
internally by Node.js
PR-URL: https://github.com/nodejs/node/pull/34741
Reviewed-By: Anna Henningsen <anna@addaleax.net >
Reviewed-By: Rich Trott <rtrott@gmail.com >
2020-08-17 11:31:26 -07:00
Rich Trott
6f12643142
doc: use _Static method_ instead of _Class Method_
...
Our docs describe static methods as Class Methods which seems
idiosyncratic for JavaScript. Align with MDN which calls them static
methods.
Refs: https://developer.mozilla.org/en-US/docs/MDN/Contribute/Structures/API_references/What_does_an_API_reference_need
JSON format for our docs will still use the key name `classMethods` for
this. I would like to change it to `staticMethods` but I don't know if
that will break things for consumers. So, leaving it alone. It's a
machine-consumable label more than a human-readable so I can live with
that.
PR-URL: https://github.com/nodejs/node/pull/34659
Reviewed-By: Michaël Zasso <targos@protonmail.com >
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: Trivikram Kamat <trivikr.dev@gmail.com >
2020-08-09 07:02:28 -07:00
Francisco Ryan Tolmasky I
fa2e460d0c
doc,tools: syntax highlight api docs at compile-time
...
Prior to this commit, API docs would be highlighted after the page
loaded using `highlightjs`. This commit still uses `highlightjs`, but
runs the generation during the compilation of the documentation, making
it so no script needs to load on the client. This results in a faster
load, as well as allowing the pages to fully functional even when
JavaScript is turned off.
PR-URL: https://github.com/nodejs/node/pull/34148
Reviewed-By: James M Snell <jasnell@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-07-16 00:22:35 +02:00
Alec Davidson
e68563e31c
doc: add dynamic source code links
...
Fixes: https://github.com/nodejs/node/pull/33977
PR-URL: https://github.com/nodejs/node/pull/33996
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-06-26 10:25:14 -07:00
Rich Trott
d408ee1be3
tools: remove superfluous regex in tools/doc/json.js
...
Remove noCallOrProp from tools/doc/json.js. It is a negative lookahead
that is only used in one regex where it is placed immediately before a
terminating $, thus rendering it meaningless.
PR-URL: https://github.com/nodejs/node/pull/33998
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: Jamie Davis <davisjam@vt.edu >
2020-06-23 15:31:39 -07:00
55360443ce
quic: initial QUIC implementation
...
Co-authored-by: Anna Henningsen <anna@addaleax.net >
Co-authored-by: Daniel Bevenius <daniel.bevenius@gmail.com >
Co-authored-by: gengjiawen <technicalcute@gmail.com >
Co-authored-by: James M Snell <jasnell@gmail.com >
Co-authored-by: Lucas Pardue <lucaspardue.24.7@gmail.com >
Co-authored-by: Ouyang Yadong <oyydoibh@gmail.com >
Co-authored-by: Juan Jos<C3><A9> Arboleda <soyjuanarbol@gmail.com >
Co-authored-by: Trivikram Kamat <trivikr.dev@gmail.com >
Co-authored-by: Denys Otrishko <shishugi@gmail.com >
PR-URL: https://github.com/nodejs/node/pull/32379
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-06-16 09:23:34 -07:00
cjihrig
862d005e60
doc: make globals Extends usage consistent
...
The docs use `* Extends: {type}` to define inheritance. This
commit updates the globals documentation to be consistent.
PR-URL: https://github.com/nodejs/node/pull/33777
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2020-06-08 21:25:26 -04:00
cjihrig
85dbd17bde
doc: make perf_hooks Extends usage consistent
...
The docs use `* Extends: {type}` to define inheritance. This
commit updates the perf_hooks documentation to be consistent.
PR-URL: https://github.com/nodejs/node/pull/33777
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2020-06-08 21:25:25 -04:00
cjihrig
2e49010bc8
doc: make events Extends usage consistent
...
The docs use `* Extends: {type}` to define inheritance. This
commit updates the events documentation to be consistent.
PR-URL: https://github.com/nodejs/node/pull/33777
Reviewed-By: Rich Trott <rtrott@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
2020-06-08 21:25:25 -04:00
James M Snell
74ca960aac
lib: initial experimental AbortController implementation
...
AbortController impl based very closely on:
https://github.com/mysticatea/abort-controller
Marked experimental.
Not currently used by any of the existing promise apis.
Signed-off-by: James M Snell <jasnell@gmail.com >
PR-URL: https://github.com/nodejs/node/pull/33527
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
Reviewed-By: Matteo Collina <matteo.collina@gmail.com >
Reviewed-By: Anna Henningsen <anna@addaleax.net >
2020-06-05 12:21:47 -07:00
Derek Lewis
e2d3230565
doc: normalize Markdown code block info strings
...
Prior to this commit, Markdown fenced code blocks in Markdown
files had inconsistent info strings. This has been corrected to
standardize on the one shown in the CommonMark spec.
Refs: https://github.com/commonmark/commonmark-spec/blob/1103710025f340702edcb070be41f9982b6544d5/spec.txt#L131
PR-URL: https://github.com/nodejs/node/pull/33542
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de >
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com >
Reviewed-By: Luigi Pinca <luigipinca@gmail.com >
Reviewed-By: James M Snell <jasnell@gmail.com >
2020-05-30 04:27:31 +02:00