Skip to content

Commit 12069ed

Browse files
coreybutleraddaleax
authored andcommitted
doc: clarify process.title inconsistencies
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. 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. Refs: #28945 PR-URL: #34557 Fixes: #34280 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Rich Trott <[email protected]>
1 parent da2d1a2 commit 12069ed

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/api/process.md

+6
Original file line numberDiff line numberDiff line change
@@ -2368,6 +2368,12 @@ allowed for longer process title strings by also overwriting the `environ`
23682368
memory but that was potentially insecure and confusing in some (rather obscure)
23692369
cases.
23702370

2371+
Assigning a value to `process.title` _may_ not reflect an accurate
2372+
(or any) label within the process manager application of the underlying
2373+
operating system (i.e. macOS Activity Monitor, Windows Services Manager, etc).
2374+
Inconsistencies and breaking changes within the _operating systems process
2375+
interface_ make synchronization with these applications unreliable.
2376+
23712377
## `process.traceDeprecation`
23722378
<!-- YAML
23732379
added: v0.8.0

0 commit comments

Comments
 (0)