hendrik/lens
1
0
Fork 0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
Code Issues Projects Releases Wiki Activity

Add documentation for power monitor functions

Browse Source 
Signed-off-by: Juho Heikka <juho.heikka@gmail.com>
This commit is contained in:
Juho Heikka 2022-02-10 18:59:20 +02:00
parent 35ffdce1d3
commit 0a7fbc1626
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/extensions/main-api/power.ts
View File

@ -4,8 +4,17 @@
*/ */
import { powerMonitor } from "electron"; import { powerMonitor } from "electron";
import type { Disposer } from "../../common/utils/disposer"; import type { Disposer } from "../../common/utils/disposer";
/**
* Event listener for system power events
*/
export type PowerEventListener = () => void; export type PowerEventListener = () => void;
/**
* Adds event listener to system suspend events
* @param listener function which will be called on system suspend
* @returns function to remove event listener
*/
export const onSuspend = (listener: PowerEventListener): Disposer => { export const onSuspend = (listener: PowerEventListener): Disposer => {
powerMonitor.on("suspend", listener); powerMonitor.on("suspend", listener);
@ -14,6 +23,11 @@ export const onSuspend = (listener: PowerEventListener): Disposer => {
}; };
}; };
/**
* Adds event listener to system resume event
* @param listener function which will be called on system resume
* @returns function to remove event listener
*/
export const onResume = (listener: PowerEventListener): Disposer => { export const onResume = (listener: PowerEventListener): Disposer => {
powerMonitor.on("resume", listener); powerMonitor.on("resume", listener);
@ -22,6 +36,12 @@ export const onResume = (listener: PowerEventListener): Disposer => {
}; };
}; };
/**
* Adds event listener to the event which is emitted when
* the system is about to reboot or shut down
* @param listener function which will be called on system shutdown
* @returns function to remove event listener
*/
export const onShutdown = (listener: PowerEventListener): Disposer => { export const onShutdown = (listener: PowerEventListener): Disposer => {
powerMonitor.on("shutdown", listener); powerMonitor.on("shutdown", listener);