mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

docs: correct powerSaveBlocker.stop(id) return type (#39320)

Browse source 
doc: correct powerSaveBlocker.stop return type
This commit is contained in:
Shelley Vohr 2023-08-02 11:39:40 +02:00 committed by GitHub
parent 303b707fbf
commit 7686d1c379
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/api/power-save-blocker.md
View file

@ -49,6 +49,8 @@ is used.
Stops the specified power save blocker. Stops the specified power save blocker.
Returns `boolean` - Whether the specified `powerSaveBlocker` has been stopped.
### `powerSaveBlocker.isStarted(id)` ### `powerSaveBlocker.isStarted(id)`
* `id` Integer - The power save blocker id returned by `powerSaveBlocker.start`. * `id` Integer - The power save blocker id returned by `powerSaveBlocker.start`.

3
spec/ts-smoke/electron/main.ts
View file

@ -904,7 +904,8 @@ app.whenReady().then(() => {
const id = powerSaveBlocker.start('prevent-display-sleep'); const id = powerSaveBlocker.start('prevent-display-sleep');
console.log(powerSaveBlocker.isStarted(id)); console.log(powerSaveBlocker.isStarted(id));
powerSaveBlocker.stop(id); const stopped = powerSaveBlocker.stop(id);
console.log(`The powerSaveBlocker is ${stopped ? 'stopped' : 'not stopped'}`);
// protocol // protocol
// https://github.com/electron/electron/blob/main/docs/api/protocol.md // https://github.com/electron/electron/blob/main/docs/api/protocol.md