electron/docs/tutorial
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
..
about.md fix: revert to previous documentation folder structure (#18127) 2019-05-02 15:17:17 -07:00
accessibility.md 📝 A11y documentation 2018-02-19 17:36:49 -06:00
app-feedback-program.md docs: Add missing document links to docs/readme (#18578) 2019-06-06 11:39:21 -07:00
application-architecture.md Update application-architecture.md (#20370) 2019-09-30 13:41:58 -04:00
application-debugging.md Remove more words (#12852) 2018-05-08 00:16:09 -05:00
application-distribution.md fix invalid lang tags (#19513) 2019-07-30 13:11:56 -07:00
application-packaging.md docs: update Electron Packager links (#19333) 2019-07-19 18:52:11 -07:00
automated-testing-with-a-custom-driver.md Es6ify api docs (#21686) 2020-01-13 10:29:46 +09:00
boilerplates-and-clis.md docs: Update boilerplates-and-clis.md (#19975) 2019-08-30 15:40:37 -05:00
code-signing.md docs: Explain notarization, improve code-signing docs (#21373) 2019-12-13 11:16:20 -05:00
debugging-main-process-vscode.md Replace workspaceRoot with workspaceFolder. (#20306) 2019-09-24 13:49:04 -04:00
debugging-main-process.md Fix typo inspector to inspect 2017-11-06 09:23:18 +09:00
desktop-environment-integration.md 📝 Fix url to unity-launcher and tiny correction (#12084) 2018-02-28 18:28:40 -06:00
development-environment.md chore: bump minimum supported macOS version to 10.10 (#15357) 2018-10-25 10:59:42 +02:00
devtools-extension.md docs: Update react devtool version in document (#21601) 2020-01-07 09:14:49 -05:00
electron-timelines.md [WIP] docs: update electron 8.0 dates (#20621) 2019-10-23 12:39:47 -04:00
electron-versioning.md fix invalid lang tags (#19513) 2019-07-30 13:11:56 -07:00
first-app.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
in-app-purchases.md Es6ify api docs (#21686) 2020-01-13 10:29:46 +09:00
installation.md docs: update installation docs to reflect latest @electron/get changes (#21491) 2019-12-16 08:16:55 -08:00
keyboard-shortcuts.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
linux-desktop-actions.md fix invalid lang tags (#19513) 2019-07-30 13:11:56 -07:00
mac-app-store-submission-guide.md docs: update Electron Packager links (#19333) 2019-07-19 18:52:11 -07:00
macos-dock.md docs: fix broken link to commit message guidelines (#13233) 2018-06-15 19:43:03 -05:00
mojave-dark-mode-guide.md docs: fix missing import, explicitly use nativeTheme api (#21937) 2020-01-31 14:49:48 +09:00
multithreading.md Fix docs lint warnings 2017-03-20 12:52:46 -07:00
native-file-drag-drop.md 📝 Native drag & drop documentation 2018-02-19 18:20:21 -06:00
notifications.md docs: fix app.setAppUserModelId link (#16322) 2019-01-08 16:40:57 -05:00
offscreen-rendering.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
online-offline-events.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
performance.md docs: correct the syntax to caniuse.com link (#21048) 2019-11-08 15:39:31 -05:00
progress-bar.md 📝 Some consistency 2018-02-19 17:28:24 -06:00
quick-start.md Fix broken link (#12387) 2018-05-16 10:23:46 -07:00
recent-documents.md remove some beginner-unfriendly terms from docs 2018-05-07 08:46:14 -07:00
repl.md Update Node.js docs link and Windows note 2016-10-06 11:38:09 -07:00
represented-file.md ❤️ One more feedback item 2018-02-21 10:29:17 -08:00
security.md docs: fix typos in security.md (#21665) 2020-01-03 11:11:01 -05:00
snapcraft.md chore: bump chromium to f5b345dd470f14eef6e44732ccf23 (master) (#20649) 2019-10-28 15:12:35 -07:00
support.md docs: move breaking changes out of API folder (#21870) 2020-01-28 22:19:18 +00:00
testing-on-headless-ci.md docs: Update incorrect author name (#19247) 2019-07-15 17:51:06 +09:00
testing-widevine-cdm.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
updates.md docs: Use Promise for dialog.showMessageBox (#21143) 2019-11-18 00:49:50 -08:00
using-native-node-modules.md fix invalid lang tags (#19513) 2019-07-30 13:11:56 -07:00
using-pepper-flash-plugin.md refactor: prefer using app.whenReady() (#21972) 2020-02-03 22:43:22 +00:00
using-selenium-and-webdriver.md docs: update selenium docs (#20336) 2019-09-24 13:36:09 -07:00
web-embeds.md docs: initial document for comparing web embeds (#20478) 2020-01-09 09:29:22 -08:00
windows-arm.md Fix node.lib download link (#21930) 2020-01-28 22:15:09 +00:00
windows-store-guide.md chore: bump chromium to f5b345dd470f14eef6e44732ccf23 (master) (#20649) 2019-10-28 15:12:35 -07:00
windows-taskbar.md docs: Use correct image URL on docs/tutorial/windows-taskbar.md (#17467) 2019-03-20 10:01:28 -07:00