mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions
electron/docs/api
History
Charles Kerr c83f836faf
refactor: prefer using app.whenReady() (#21972) 
* docs: add references to app.whenReady() in isReady

* refactor: prefer app.whenReady()

In the docs, specs, and lib, replace instances of `app.once('ready')`
(seen occasionally) and `app.on('ready')` (extremely common) with
`app.whenReady()`.

It's better to encourage users to use whenReady():
1. it handles the edge case of registering for 'ready' after it's fired
2. it avoids the minor wart of leaving an active listener alive for
an event that wll never fire again
2020-02-03 22:43:22 +00:00
..
modernization chore: remove unused promisify code (#21114) 2019-11-14 14:50:50 +09:00
structures feat: enable native extensions support (#21814) 2020-02-03 14:01:10 -08:00
accelerator.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
app.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
auto-updater.md docs: remove implicit 'any' and 'Object' types from the docs (#19585) 2019-08-05 10:45:58 -07:00
browser-view.md docs: windows don't need to be retained (#21957) 2020-01-30 14:15:35 -08:00
browser-window-proxy.md refactor: use IPC helpers in window-setup (#17948) 2019-07-09 02:43:49 +03:00
browser-window.md feat: enable native extensions support (#21814) 2020-02-03 14:01:10 -08:00
client-request.md refactor: rewrite the net module to simplify state tracking (#21244) 2019-11-26 17:01:13 -08:00
clipboard.md docs: improve and add examples for clipboard (#20224) 2019-09-18 16:00:43 -07:00
command-line-switches.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
command-line.md feat: add --enable-api-filtering-logging commandline switch (#20335) 2019-10-04 10:49:09 -07:00
content-tracing.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
context-bridge.md docs: clean up context bridge API docs (#21888) 2020-01-27 17:14:54 -06:00
cookies.md docs: fix spelling and grammar errors (#18910) 2019-06-21 16:19:21 -05:00
crash-reporter.md test: move crashReporter specs to the main process (#20417) 2019-10-14 14:38:54 -07:00
debugger.md test: move debugger spec to main process (#20514) 2019-10-14 14:32:11 +09:00
desktop-capturer.md feat: add 'screen' to systemPreferences.getMediaAccessStatus() (#20764) 2019-11-13 16:47:51 -05:00
dialog.md docs: added info on bookmark return values for securityScopedBookmarks (#17584) 2020-01-23 10:17:39 +09:00
dock.md docs: clarify dock.bounce usage (#19894) 2019-08-23 01:16:18 -07:00
download-item.md doc: improve EventEmitter md formatting (#19345) 2019-07-22 08:20:43 -07:00
environment-variables.md feat: allow http-parser NODE_OPTION in packaged apps (#21694) 2020-01-09 08:09:14 -08:00
file-object.md docs: es6ify 'Breaking Changes' and 'File' API pages (#15507) 2018-12-05 23:14:52 +11:00
frameless-window.md fix: incorrect view ordering for customButtonsOnHover (#15564) 2018-12-10 11:05:30 -08:00
global-shortcut.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
in-app-purchase.md feat: enable explicit IAP restoration (#21461) 2019-12-17 07:07:11 -08:00
incoming-message.md docs: remove implicit 'any' and 'Object' types from the docs (#19585) 2019-08-05 10:45:58 -07:00
ipc-main.md docs: the ipc main listener being removed can have args (#20712) 2019-10-29 13:18:39 +09:00
ipc-renderer.md refactor: use v8 serialization for ipc (#20214) 2019-10-09 13:59:08 -04:00
locales.md Use actual Chromium l10n_util list in locales.md 2017-05-01 17:15:37 -04:00
menu-item.md docs: menu item labels are not dynamic (#21823) 2020-01-20 15:44:22 +09:00
menu.md docs: fix undefined isMac in menu example (#19071) 2019-07-02 10:09:10 -05:00
native-image.md docs: fix isMactemplateImage type definition (#21166) 2019-11-18 10:57:22 -08:00
native-theme.md update (#21915) 2020-01-29 18:42:25 +09:00
net-log.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
net.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
notification.md feat: allow Linux/Windows users to set notification timeout (#20153) 2019-10-09 11:22:21 -04:00
power-monitor.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
power-save-blocker.md chore: update to standard 12 2018-09-14 14:57:01 +10:00
process.md chore: remove unused promisify code (#21114) 2019-11-14 14:50:50 +09:00
protocol-ns.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
protocol.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
remote.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
sandbox-option.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
screen.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
session.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
shell.md docs: fix shell.openPath documentation (#21641) 2019-12-30 11:40:30 -08:00
synopsis.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
system-preferences.md feat: add 'screen' to systemPreferences.getMediaAccessStatus() (#20764) 2019-11-13 16:47:51 -05:00
touch-bar-button.md feat: allow TouchBarButton instances to be disabled (#20945) 2019-11-05 15:56:36 -08:00
touch-bar-color-picker.md 📝 Fix dead urls 2018-04-09 17:58:10 -03:00
touch-bar-group.md 📝 Fix dead urls 2018-04-09 17:58:10 -03:00
touch-bar-label.md feat: improve TouchBarButton accessibility (#20454) 2019-10-08 11:13:57 -04:00
touch-bar-popover.md docs: fix TouchBar related documentation (#19444) 2019-08-01 10:59:26 -04:00
touch-bar-scrubber.md docs: fix TouchBar related documentation (#19444) 2019-08-01 10:59:26 -04:00
touch-bar-segmented-control.md docs: fix TouchBar related documentation (#19444) 2019-08-01 10:59:26 -04:00
touch-bar-slider.md 📝 Fix dead urls 2018-04-09 17:58:10 -03:00
touch-bar-spacer.md docs: fix TouchBar related documentation (#19444) 2019-08-01 10:59:26 -04:00
touch-bar.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
tray.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
web-contents.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
web-frame.md feat: remove deprecated setLayoutZoomLevelLimits (#21383) 2019-12-06 13:14:25 -08:00
web-request.md docs: responseHeaders should be Record<string, string[]> (#21730) 2020-01-12 09:20:13 -08:00
webview-tag.md docs: fix missing docs for <webview>.print() (#21962) 2020-01-29 17:12:45 -08:00
window-open.md docs: specify BrowserWindow features passable to window.open 2018-09-10 17:49:54 +02:00