Skip to content

Commit d9b0d14

Browse files
committed
Fixed and updated readme
1 parent 0e69a68 commit d9b0d14

File tree

2 files changed

+1
-2
lines changed

2 files changed

+1
-2
lines changed

packages/monitor/README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,6 @@ Global options for how window order should be managed.
133133
| - | - | - | - |
134134
| <a name="module_monitor-options.WindowsApiOptions+nodeVersion">`nodeVersion`</a> | <code>string</code>| <code>'>=17.4.0'</code> | The minimum major node version to support window ordering.<br>Node versions < 17 seem to have a fatal bug with the native<br>API, which will intermittently cause V8 to crash hard.<br><br>See: https://github.com/node-ffi-napi/ref-napi/issues/54#issuecomment-1029639256 |
135135
| <a name="module_monitor-options.WindowsApiOptions+debounceDelay">`debounceDelay`</a> | <code>number</code>| <code>3000</code> | The delay until windows are ordered after launch of in ms.<br><br>If your app takes a long time to open all of its windows, set this number to a higher value to ensure it can be on top of the launchpad terminal window.<br><br>Keeping this high also reduces the CPU load if apps relaunch often. |
136-
| <a name="module_monitor-options.WindowsApiOptions+fakeKey">`fakeKey`</a> | <code>string</code>| <code>'control'</code> | Windows OS is very strict with when and how apps can move windows to the foreground or backgruond. As a workaround, Launchpad emulates a keypress to make the current process active.<br><br>This setting configures which key is used to emulate in order to gain control over window foregrounding/backgrounding. This key gets emulated after an app launches or re-launches.<br><br>See: https://robotjs.io/docs/syntax#keys for available options, https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-allowsetforegroundwindow#remarks for window management requirements. |
137136

138137

139138
### AppLogOptions

packages/monitor/lib/utils/sort-windows.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export class SortApp {
2020
* @param {Array.<SortApp>} apps
2121
* @param {Logger} logger
2222
* @param {string} minNodeVersion
23-
* @returns
23+
* @returns {Promise}
2424
*/
2525
const sortWindows = async (apps, logger = console, minNodeVersion = undefined) => {
2626
const currNodeVersion = process.version;

0 commit comments

Comments
 (0)