Browse Source

docs: fix powerMonitor event types (34-x-y) (#45615)

docs: fix powerMonitor event types (#45518)

* fix: powerMonitor event types

* fix: thermal-state-change missing Returns

Co-authored-by: Sam Maddock <[email protected]>
Charles Kerr 2 months ago
parent
commit
a9f3754d22
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
@@ -42,7 +45,8 @@ See https://developer.apple.com/library/archive/documentation/Performance/Concep
 
 ### Event: 'speed-limit-change' _macOS_ _Windows_
 
-* `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