Skip to content

doc: change worker.takeHeapSnapshot to getHeapSnapshot #32061

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Closed
wants to merge 2 commits into from
Closed

doc: change worker.takeHeapSnapshot to getHeapSnapshot #32061

wants to merge 2 commits into from

Conversation

Flarna
Copy link
Member

@Flarna Flarna commented Mar 3, 2020

Adapt doc to match implementation which exports getHeapSnapshot().

Refs: #31569
Refs:

node/lib/internal/worker.js

Line 323 in 987a673

getHeapSnapshot() {

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. worker Issues and PRs related to Worker support. labels Mar 3, 2020
@Flarna Flarna mentioned this pull request Mar 3, 2020
Merged
9 tasks
@Trott
Copy link
Member

Trott commented Mar 3, 2020

Nit: To maintain alphabetical order, the entry will need to be moved from its current location to above worker.postMessage().

mmarchini
mmarchini approved these changes Mar 3, 2020
View reviewed changes
Copy link
Contributor

@mmarchini mmarchini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM % @Trott comment

@Flarna
Copy link
Member Author

Flarna commented Mar 3, 2020

Nit: To maintain alphabetical order, the entry will need to be moved from its current location to above worker.postMessage().

moved.

@legendecas
Copy link
Member

Is it worth to mention that this API doesn't share an identical signature with v8.getHeapSnapshot? i.e. worker.{take,get}Snapshot returns a promise of stream, and v8.getHeapSnapshot returns a plain stream.

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 9, 2020
Flarna added 2 commits March 10, 2020 08:53
@Flarna
doc: change worker.takeHeapSnapshot to getHeapSnapshot
678fa77 
Adapt doc to match implementation which exports getHeapSnapshot().
@Flarna
ensure alphabetical order
4a9b8cc
@Flarna Flarna force-pushed the doc_worker_getheadsnapshot branch from 9a60ad5 to 4a9b8cc Compare March 10, 2020 07:53
@Flarna
Copy link
Member Author

Flarna commented Mar 10, 2020

rebased, hopefully ASAN build is now green.

mmarchini pushed a commit that referenced this pull request Mar 10, 2020
@Flarna @mmarchini
doc: change worker.takeHeapSnapshot to getHeapSnapshot
28fae8b 
Adapt doc to match implementation which exports getHeapSnapshot().

PR-URL: #32061
Refs: #31569
Refs: https://github.com/nodejs/node/blob/987a67339518d0380177a2e589f2bbd274230d0e/lib/internal/worker.js#L323
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@mmarchini
Copy link
Contributor

Landed in 28fae8b

@mmarchini mmarchini closed this Mar 10, 2020
@Flarna Flarna deleted the doc_worker_getheadsnapshot branch March 10, 2020 17:42
MylesBorins pushed a commit that referenced this pull request Mar 10, 2020
@Flarna @MylesBorins
doc: change worker.takeHeapSnapshot to getHeapSnapshot
bc1e357 
Adapt doc to match implementation which exports getHeapSnapshot().

PR-URL: #32061
Refs: #31569
Refs: https://github.com/nodejs/node/blob/987a67339518d0380177a2e589f2bbd274230d0e/lib/internal/worker.js#L323
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@MylesBorins MylesBorins mentioned this pull request Mar 10, 2020
Merged
@targos targos added backport-blocked-v12.x and removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. backport-blocked-v12.x labels Apr 20, 2020
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@Flarna @targos
doc: change worker.takeHeapSnapshot to getHeapSnapshot
0509360 
Adapt doc to match implementation which exports getHeapSnapshot().

PR-URL: nodejs#32061
Refs: nodejs#31569
Refs: https://github.com/nodejs/node/blob/987a67339518d0380177a2e589f2bbd274230d0e/lib/internal/worker.js#L323
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
targos pushed a commit that referenced this pull request Apr 28, 2020
@Flarna @targos
doc: change worker.takeHeapSnapshot to getHeapSnapshot
f5b60ec 
Adapt doc to match implementation which exports getHeapSnapshot().

PR-URL: #32061
Refs: #31569
Refs: https://github.com/nodejs/node/blob/987a67339518d0380177a2e589f2bbd274230d0e/lib/internal/worker.js#L323
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Shelley Vohr <codebytere@gmail.com>
Reviewed-By: Matheus Marchini <mat@mmarchini.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@targos targos mentioned this pull request May 2, 2020
Merged
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@Trott Trott Trott approved these changes

@addaleax addaleax addaleax approved these changes

@lpinca lpinca lpinca approved these changes

@codebytere codebytere codebytere approved these changes

@cjihrig cjihrig cjihrig approved these changes

@mmarchini mmarchini mmarchini approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. worker Issues and PRs related to Worker support.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.