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

Fix docs: app.md setLoginItemSettings

Browse source 
`app.setLoginItemSettings` documented arguments are misleading -- `path` and `args` should be passed in the `settings` object, not as separate params, like the code sample below it or in the test file here: 9250b559f9/spec/api-app-spec.js (L336)
and in the actual C++ function declaration here: f5a75c4e87/atom/browser/browser.h (L104)
This commit is contained in:
Cameron Nokes 2017-06-21 16:24:00 -06:00 • committed by GitHub
parent 3abeb6e2bc
commit 3239da37dd
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/api/app.md
View file

@ -825,7 +825,7 @@ Returns `Object`:
**Note:** This API has no effect on [MAS builds][mas-builds]. **Note:** This API has no effect on [MAS builds][mas-builds].
### `app.setLoginItemSettings(settings[, path, args])` _macOS_ _Windows_ ### `app.setLoginItemSettings(settings)` _macOS_ _Windows_
* `settings` Object * `settings` Object
* `openAtLogin` Boolean (optional) - `true` to open the app at login, `false` to remove * `openAtLogin` Boolean (optional) - `true` to open the app at login, `false` to remove
@ -835,11 +835,11 @@ Returns `Object`:
`app.getLoginItemStatus().wasOpenedAsHidden` should be checked when the app `app.getLoginItemStatus().wasOpenedAsHidden` should be checked when the app
is opened to know the current value. This setting is only supported on is opened to know the current value. This setting is only supported on
macOS. macOS.
* `path` String (optional) _Windows_ - The executable to launch at login. * `path` String (optional) _Windows_ - The executable to launch at login.
Defaults to `process.execPath`. Defaults to `process.execPath`.
* `args` String[] (optional) _Windows_ - The command-line arguments to pass to * `args` String[] (optional) _Windows_ - The command-line arguments to pass to
the executable. Defaults to an empty array. Take care to wrap paths in the executable. Defaults to an empty array. Take care to wrap paths in
quotes. quotes.
Set the app's login item settings. Set the app's login item settings.