electron/docs/api
trop[bot] 3764c4d0b3
docs: Make ipcRenderer and ipcMain listener API docs consistent (#44711)
* docs: Make ipcRenderer and ipcMain listener API docs consistent

Co-authored-by: Will Anderson <will@itsananderson.com>

* test: add some unit tests for ipcRenderer/ipcMain listener behavior

Co-authored-by: Will Anderson <will@itsananderson.com>

* fix: Mark on/off methods as primary and addListener/removeListener as aliases

Co-authored-by: Will Anderson <will@itsananderson.com>

* fix: clear all listeners before running ipcMain removeAllListeners tests

Co-authored-by: Will Anderson <will@itsananderson.com>

---------

Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com>
Co-authored-by: Will Anderson <will@itsananderson.com>
2024-11-19 09:47:45 +01:00
..
structures docs: add custom titlebar example (#44506) 2024-11-01 12:47:51 -05:00
accelerator.md docs: note accelerator case insensitivity (#40783) 2024-01-04 10:06:12 -05:00
app.md chore: remove executable flag from docs/api/app.md file permissions (#44580) 2024-11-05 12:12:40 -05:00
auto-updater.md docs: add advanced specification for Squirrel updater (#43234) 2024-09-23 10:20:43 -07:00
base-window.md fix: update shell.openExternal to correctly focus on external window (#44469) 2024-10-31 12:05:44 +01:00
browser-view.md docs: api history (#42982) 2024-08-19 11:17:10 -07:00
browser-window.md docs: api history (#42982) 2024-08-19 11:17:10 -07:00
client-request.md build: update some build dependencies (#43882) 2024-09-26 00:12:11 -07:00
clipboard.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
command-line-switches.md fix: revert required portal version for file chooser dialogs (#44681) 2024-11-15 11:30:06 -05:00
command-line.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
content-tracing.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
context-bridge.md docs: explain ipcRenderer behavior in context-bridge.md (#43455) 2024-09-05 16:48:22 -04:00
cookies.md refactor: revert url::DomainIs() for cookie domains (#44153) 2024-10-08 18:39:37 -07:00
crash-reporter.md docs: backslash escape parametrized TypeScript types (#41575) 2024-03-25 11:19:44 +01:00
debugger.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
desktop-capturer.md feat: add support for system picker in setDisplayMediaRequestHandler (#43581) 2024-09-10 16:05:57 -07:00
dialog.md fix: revert required portal version for file chooser dialogs (#44681) 2024-11-15 11:30:06 -05:00
dock.md docs: fix the Apple HIG link for Dock context menu (#42450) 2024-06-13 15:24:05 -05:00
download-item.md feat: add `getPercentComplete` / `getCurrentBytesPerSecond` / `getEndTime` to DownloadItem (#42805) 2024-07-15 19:32:44 -04:00
environment-variables.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
extensions.md docs: ensure all links are on a single line (#42235) 2024-05-28 11:15:18 -07:00
global-shortcut.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
in-app-purchase.md feat: added username to IAP purchaseProduct method (#35902) 2022-12-12 10:11:48 -08:00
incoming-message.md build: update some build dependencies (#43882) 2024-09-26 00:12:11 -07:00
ipc-main.md docs: Make ipcRenderer and ipcMain listener API docs consistent (#44711) 2024-11-19 09:47:45 +01:00
ipc-renderer.md docs: Make ipcRenderer and ipcMain listener API docs consistent (#44711) 2024-11-19 09:47:45 +01:00
menu-item.md fix: menu should allow focused `BaseWindow` where possible (#43404) 2024-08-22 14:13:30 -04:00
menu.md docs: use "id" instead of "label" for positions (#41843) 2024-04-14 17:10:09 -07:00
message-channel-main.md chore: type check JS in docs (#38423) 2023-06-05 16:26:26 +09:00
message-port-main.md docs: fix broken links (#36519) 2022-12-05 13:18:57 -05:00
native-image.md docs: api history (#42982) 2024-08-19 11:17:10 -07:00
native-theme.md feat: add transparency checking to `nativeTheme` (#42862) 2024-07-24 14:38:22 +02:00
navigation-history.md feat: extend navigationHistory API (#42014) 2024-08-19 15:46:04 -04:00
net-log.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
net.md docs - Update net.md (#42691) 2024-07-01 14:45:49 -04:00
notification.md docs: clarify icon value in Notification (#43377) 2024-08-21 19:38:06 -05:00
parent-port.md docs: fix broken links (#36519) 2022-12-05 13:18:57 -05:00
power-monitor.md feat: add thermal states to powerMonitor (#37935) 2023-04-19 11:46:55 +02:00
power-save-blocker.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
process.md chore: bump chromium to 124.0.6323.0 (main) (#41412) 2024-02-29 10:31:13 +01:00
protocol.md docs: api history (#42982) 2024-08-19 11:17:10 -07:00
push-notifications.md docs: backslash escape parametrized TypeScript types (#41575) 2024-03-25 11:19:44 +01:00
safe-storage.md docs: clarify security semantics of safeStorage (#42666) 2024-06-26 13:24:06 -07:00
screen.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
service-workers.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
session.md docs: clarify that sessions use cache by default (#44576) 2024-11-05 10:39:58 -06:00
share-menu.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
shell.md docs: capitalize POSIX and Windows correctly (#44559) 2024-11-04 16:43:05 -05:00
system-preferences.md feat: add transparency checking to `nativeTheme` (#42862) 2024-07-24 14:38:22 +02:00
touch-bar-button.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-color-picker.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-group.md fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00
touch-bar-label.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-other-items-proxy.md fix: ensure the typescript definitions only export correct value types (#28712) 2021-06-15 13:50:31 -07:00
touch-bar-popover.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-scrubber.md fix: documentation spelling errors (#43366) 2024-08-22 15:44:55 +02:00
touch-bar-segmented-control.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-slider.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar-spacer.md docs: type names changed from wrapper to primitive (#31752) 2021-11-15 22:13:18 -06:00
touch-bar.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00
tray.md docs: `nativeImage` api cleanup (#41519) 2024-03-12 12:33:56 -04:00
utility-process.md fix: `utilityProcess` pid should be `undefined` after exit (#44695) 2024-11-18 14:44:14 +01:00
view.md docs: document View.removeChildView edge case (#43673) 2024-09-16 11:32:03 +02:00
web-contents-view.md feat: Allow WebContentsView to accept webContents object. (#42086) 2024-05-30 12:45:35 -07:00
web-contents.md feat: add WebFrameMain detached property (#43473) 2024-10-11 18:33:53 -04:00
web-frame-main.md feat: add WebFrameMain detached property (#43473) 2024-10-11 18:33:53 -04:00
web-frame.md docs: fix apostrophe typo "Electrons" -> "Electron's" (#44537) 2024-11-03 09:33:10 -06:00
web-request.md feat: add WebFrameMain detached property (#43473) 2024-10-11 18:33:53 -04:00
web-utils.md fix: documentation spelling errors (#43366) 2024-08-22 15:44:55 +02:00
webview-tag.md fix: fixed the type of `WebviewTag.webpreferences` (#42275) 2024-05-25 22:06:06 -07:00
window-open.md chore: extend linting of code blocks in the docs (#40245) 2023-11-21 16:50:08 +09:00