Skip to content

doc: clarify process.title inconsistencies #34557

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
coreybutler wants to merge 2 commits into from
Closed

doc: clarify process.title inconsistencies #34557

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3832439
Add a note about process.title
coreybutler Jul 29, 2020
6a97cc4
Comply with doc linting rules
coreybutler Jul 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add a note about process.title 
Many users assume the act of assigning a value to `process.title` will update the name of their application in apps like macOS Activity Monitor or Windows Services Manager. This has worked in the past, but fails in some versions of Node.js (see #28945). Ultimately developers are left confused, especially when it works in one version of Node.js and not another. Given the recurring nature and complexity of the underlying problem, it does not seem like a resolvable problem. This note clarifies the source of the problem, sets developer expectations, and closes #34280.
  • Loading branch information
@coreybutler
coreybutler authored Jul 29, 2020
commit 383243942ccad26412771471b2c93c5415513f68
6 changes: 6 additions & 0 deletions doc/api/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2423,6 +2423,12 @@ allowed for longer process title strings by also overwriting the `environ`
memory but that was potentially insecure and confusing in some (rather obscure)
cases.

Note that assigning a value to `process.title` _may_ not reflect an accurate
(or any) label within the process manager application of the underlying
operating system (i.e. macOS Activity Monitor, Windows Services Manager, etc).
Inconsistencies and breaking changes within the _operating systems process
interface_ make synchronization with these applications unreliable.

## `process.traceDeprecation`
<!-- YAML
added: v0.8.0
Expand Down