doc: add ESM version examples to events api doc #43226

F3n67u · 2022-05-28T03:59:11Z

This pr adds ESM version examples to events API doc. This is done to put more emphasis on the ESM.

inspired by #37170

lpinca

RSLGTM.

doc/api/events.md

Co-authored-by: James M Snell <jasnell@gmail.com>

doc/api/events.md

F3n67u · 2022-06-18T13:25:08Z

Anybody could help to land this pr? Thanks.

nodejs-github-bot · 2022-06-18T15:32:05Z

Commit Queue failed

- Loading data for nodejs/node/pull/43226 ✔ Done loading data for nodejs/node/pull/43226 ----------------------------------- PR info ------------------------------------ Title doc: add ESM version examples to events api doc (#43226) Author Feng Yu (@F3n67u) Branch F3n67u:doc/events -> nodejs:main Labels doc, events Commits 6 - doc: add ESM version examples to events api doc - Update doc/api/events.md - Update doc/api/events.md - Update doc/api/events.md - squash: replace with import { EventEmitter } from 'node:events' - squash: use EventEmitter.captureRejections = true Committers 2 - Feng Yu - GitHub PR-URL: https://github.com/nodejs/node/pull/43226 Reviewed-By: Luigi Pinca Reviewed-By: James M Snell ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/43226 Reviewed-By: Luigi Pinca Reviewed-By: James M Snell -------------------------------------------------------------------------------- ℹ This PR was created on Sat, 28 May 2022 03:59:11 GMT ✔ Approvals: 2 ✔ - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/43226#pullrequestreview-1003491311 ✔ - James M Snell (@jasnell) (TSC): https://github.com/nodejs/node/pull/43226#pullrequestreview-1006095214 ✔ Last GitHub CI successful ℹ Green GitHub CI is sufficient -------------------------------------------------------------------------------- ✔ No git cherry-pick in progress ✔ No git am in progress ✔ No git rebase in progress -------------------------------------------------------------------------------- - Bringing origin/main up to date... From https://github.com/nodejs/node * branch main -> FETCH_HEAD ✔ origin/main is now up-to-date - Downloading patch for 43226 From https://github.com/nodejs/node * branch refs/pull/43226/merge -> FETCH_HEAD ✔ Fetched commits as dc53c29b97e8..b10cd7cccc24 -------------------------------------------------------------------------------- Auto-merging doc/api/events.md [main 617e818863] doc: add ESM version examples to events api doc Author: Feng Yu Date: Sat May 28 11:50:20 2022 +0800 1 file changed, 345 insertions(+), 18 deletions(-) Auto-merging doc/api/events.md [main aa89f12a5c] Update doc/api/events.md Author: Feng Yu Date: Sun Jun 12 09:48:24 2022 +0800 1 file changed, 1 insertion(+), 1 deletion(-) Auto-merging doc/api/events.md [main e06099fad3] Update doc/api/events.md Author: Feng Yu Date: Sun Jun 12 09:48:38 2022 +0800 1 file changed, 1 insertion(+), 1 deletion(-) Auto-merging doc/api/events.md [main 10667e20e7] Update doc/api/events.md Author: Feng Yu Date: Sun Jun 12 09:48:48 2022 +0800 1 file changed, 1 insertion(+), 1 deletion(-) Auto-merging doc/api/events.md [main e4a53f8429] squash: replace with import { EventEmitter } from 'node:events' Author: Feng Yu Date: Sun Jun 12 10:22:03 2022 +0800 1 file changed, 2 insertions(+), 2 deletions(-) Auto-merging doc/api/events.md [main 28a86183ef] squash: use EventEmitter.captureRejections = true Author: Feng Yu Date: Tue Jun 14 06:18:24 2022 +0000 1 file changed, 3 insertions(+), 3 deletions(-) ✔ Patches applied There are 6 commits in the PR. Attempting autorebase. Rebasing (2/12)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
doc: add ESM version examples to events api doc

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

[detached HEAD 81e8584706] doc: add ESM version examples to events api doc
Author: Feng Yu F3n67u@outlook.com
Date: Sat May 28 11:50:20 2022 +0800
1 file changed, 345 insertions(+), 18 deletions(-)
Rebasing (3/12)
Rebasing (4/12)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
Update doc/api/events.md

Co-authored-by: James M Snell jasnell@gmail.com

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

[detached HEAD 1e51e006e9] Update doc/api/events.md
Author: Feng Yu F3n67u@outlook.com
Date: Sun Jun 12 09:48:24 2022 +0800
1 file changed, 1 insertion(+), 1 deletion(-)
Rebasing (5/12)
Rebasing (6/12)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
Update doc/api/events.md

Co-authored-by: James M Snell jasnell@gmail.com

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

[detached HEAD b1a249f3cc] Update doc/api/events.md
Author: Feng Yu F3n67u@outlook.com
Date: Sun Jun 12 09:48:38 2022 +0800
1 file changed, 1 insertion(+), 1 deletion(-)
Rebasing (7/12)
Rebasing (8/12)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
Update doc/api/events.md

Co-authored-by: James M Snell jasnell@gmail.com

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

[detached HEAD 8acd38a88e] Update doc/api/events.md
Author: Feng Yu F3n67u@outlook.com
Date: Sun Jun 12 09:48:48 2022 +0800
1 file changed, 1 insertion(+), 1 deletion(-)
Rebasing (9/12)
Rebasing (10/12)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
squash: replace with import { EventEmitter } from 'node:events'

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

[detached HEAD cc364571b4] squash: replace with import { EventEmitter } from 'node:events'
Author: Feng Yu F3n67u@outlook.com
Date: Sun Jun 12 10:22:03 2022 +0800
1 file changed, 2 insertions(+), 2 deletions(-)
Rebasing (11/12)
Rebasing (12/12)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
squash: use EventEmitter.captureRejections = true

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

[detached HEAD fc4d0fcb63] squash: use EventEmitter.captureRejections = true
Author: Feng Yu F3n67u@outlook.com
Date: Tue Jun 14 06:18:24 2022 +0000
1 file changed, 3 insertions(+), 3 deletions(-)

Successfully rebased and updated refs/heads/main.

ℹ Use --fixupAll option, squash the PR manually or land the PR from the command line.

https://github.com/nodejs/node/actions/runs/2520904293

lpinca · 2022-06-18T15:38:04Z

Landed in 1737c77.

PR-URL: #43226 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

F3n67u · 2022-06-19T00:54:37Z

Landed in 1737c77.

@lpinca Thanks❤️.

PR-URL: #43226 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

PR-URL: nodejs/node#43226 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

F3n67u marked this pull request as ready for review May 28, 2022 03:59

nodejs-github-bot added doc Issues and PRs related to the documentations. events Issues and PRs related to the events subsystem / EventEmitter. labels May 28, 2022

F3n67u force-pushed the doc/events branch from 997f9d5 to fe6e8ef Compare May 28, 2022 04:05

doc: add ESM version examples to events api doc

ec9e3f1

F3n67u force-pushed the doc/events branch from fe6e8ef to ec9e3f1 Compare May 28, 2022 04:08

lpinca approved these changes Jun 11, 2022

View reviewed changes

jasnell reviewed Jun 12, 2022

View reviewed changes

doc/api/events.md Outdated Show resolved Hide resolved

jasnell reviewed Jun 12, 2022

View reviewed changes

doc/api/events.md Outdated Show resolved Hide resolved

jasnell reviewed Jun 12, 2022

View reviewed changes

doc/api/events.md Outdated Show resolved Hide resolved

F3n67u and others added 4 commits June 12, 2022 09:48

Update doc/api/events.md

a47d21d

Co-authored-by: James M Snell <jasnell@gmail.com>

Update doc/api/events.md

07652b7

Co-authored-by: James M Snell <jasnell@gmail.com>

Update doc/api/events.md

5260dc4

Co-authored-by: James M Snell <jasnell@gmail.com>

squash: replace with import { EventEmitter } from 'node:events'

0fd79f3

F3n67u commented Jun 12, 2022

View reviewed changes

doc/api/events.md Outdated Show resolved Hide resolved

F3n67u requested a review from jasnell June 14, 2022 06:21

squash: use EventEmitter.captureRejections = true

b10cd7c

F3n67u force-pushed the doc/events branch from dd59c03 to b10cd7c Compare June 14, 2022 06:30

jasnell approved these changes Jun 14, 2022

View reviewed changes

lpinca added the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 18, 2022

nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Jun 18, 2022

lpinca pushed a commit that referenced this pull request Jun 18, 2022

doc: add ESM version examples to events api doc

1737c77

PR-URL: #43226 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

lpinca closed this Jun 18, 2022

F3n67u deleted the doc/events branch June 19, 2022 00:53

targos pushed a commit that referenced this pull request Jul 12, 2022

doc: add ESM version examples to events api doc

b111331

PR-URL: #43226 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

targos mentioned this pull request Jul 12, 2022

v18.6.0 release proposal #43789

Merged

targos pushed a commit that referenced this pull request Jul 18, 2022

doc: add ESM version examples to events api doc

e9ca069

PR-URL: #43226 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

targos pushed a commit that referenced this pull request Jul 31, 2022

doc: add ESM version examples to events api doc

982e99e

PR-URL: #43226 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

targos mentioned this pull request Aug 3, 2022

v16.17.0 release proposal #44098

Merged

guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022

doc: add ESM version examples to events api doc

125a6e1

PR-URL: nodejs/node#43226 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: add ESM version examples to events api doc #43226

doc: add ESM version examples to events api doc #43226

F3n67u commented May 28, 2022

lpinca left a comment

F3n67u commented Jun 18, 2022

nodejs-github-bot commented Jun 18, 2022

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

Successfully rebased and updated refs/heads/main.

lpinca commented Jun 18, 2022

F3n67u commented Jun 19, 2022

doc: add ESM version examples to events api doc #43226

doc: add ESM version examples to events api doc #43226

Conversation

F3n67u commented May 28, 2022

lpinca left a comment

Choose a reason for hiding this comment

F3n67u commented Jun 18, 2022

nodejs-github-bot commented Jun 18, 2022

PR-URL: #43226 Reviewed-By: Luigi Pinca luigipinca@gmail.com Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226 Reviewed-By: Luigi Pinca luigipinca@gmail.com Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226 Reviewed-By: Luigi Pinca luigipinca@gmail.com Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226 Reviewed-By: Luigi Pinca luigipinca@gmail.com Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226 Reviewed-By: Luigi Pinca luigipinca@gmail.com Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226 Reviewed-By: Luigi Pinca luigipinca@gmail.com Reviewed-By: James M Snell jasnell@gmail.com

Successfully rebased and updated refs/heads/main.

lpinca commented Jun 18, 2022

F3n67u commented Jun 19, 2022

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com

PR-URL: #43226
Reviewed-By: Luigi Pinca luigipinca@gmail.com
Reviewed-By: James M Snell jasnell@gmail.com