Browse Source

docs: fix powerMonitor event types (#45543)

* fix: powerMonitor event types

Co-authored-by: Samuel Maddock <[email protected]>

* fix: thermal-state-change missing Returns

Co-authored-by: Samuel Maddock <[email protected]>

---------

Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: Samuel Maddock <[email protected]>
trop[bot] 2 months ago
parent
commit
2bce515091
1 changed files with 6 additions and 2 deletions
  1. 6 2
      docs/api/power-monitor.md

+ 6 - 2
docs/api/power-monitor.md

@@ -26,7 +26,10 @@ Emitted when system changes to battery power.
 
 ### Event: 'thermal-state-change' _macOS_
 
-* `state` string - The system's new thermal state. Can be `unknown`, `nominal`, `fair`, `serious`, `critical`.
+Returns:
+
+* `details` Event\<\>
+  * `state` string - The system's new thermal state. Can be `unknown`, `nominal`, `fair`, `serious`, `critical`.
 
 Emitted when the thermal state of the system changes. Notification of a change
 in the thermal status of the system, such as entering a critical temperature
@@ -44,7 +47,8 @@ See https://developer.apple.com/library/archive/documentation/Performance/Concep
 
 Returns:
 
-* `limit` number - The operating system's advertised speed limit for CPUs, in percent.
+* `details` Event\<\>
+  * `limit` number - The operating system's advertised speed limit for CPUs, in percent.
 
 Notification of a change in the operating system's advertised speed limit for
 CPUs, in percent. Values below 100 indicate that the system is impairing