@overwolf/ow-electron 22.3.3 → 22.3.13-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/checksums.json +8 -8
- package/electron-api.json +265 -290
- package/electron.d.ts +21 -23
- package/ow-electron.d.ts +34 -16
- package/package.json +5 -2
package/electron-api.json
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
"description": "> Control your application's event lifecycle.\n\nProcess: Main\n\nThe following example shows how to quit the application when the last window is closed:",
|
|
5
5
|
"slug": "app",
|
|
6
6
|
"websiteUrl": "https://electronjs.org/docs/api/app",
|
|
7
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
8
|
-
"version": "22.3.
|
|
7
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/app.md",
|
|
8
|
+
"version": "22.3.13",
|
|
9
9
|
"type": "Module",
|
|
10
10
|
"process": {
|
|
11
11
|
"main": true,
|
|
@@ -459,37 +459,12 @@
|
|
|
459
459
|
{
|
|
460
460
|
"name": "getPreferredSystemLanguages",
|
|
461
461
|
"signature": "()",
|
|
462
|
-
"description": "The user's preferred system languages from most preferred to least preferred, including the country codes if applicable. A user can modify and add to this list on Windows or macOS through the Language and Region settings.\n\nThe API uses `GlobalizationPreferences` (with a fallback to `GetSystemPreferredUILanguages`) on Windows, `\\[NSLocale preferredLanguages\\]` on macOS, and `g_get_language_names` on Linux.\n\nThis API can be used for purposes such as deciding what language to present the application in.\n\nHere are some examples of return values of the various language and locale APIs with different configurations:\n\
|
|
462
|
+
"description": "The user's preferred system languages from most preferred to least preferred, including the country codes if applicable. A user can modify and add to this list on Windows or macOS through the Language and Region settings.\n\nThe API uses `GlobalizationPreferences` (with a fallback to `GetSystemPreferredUILanguages`) on Windows, `\\[NSLocale preferredLanguages\\]` on macOS, and `g_get_language_names` on Linux.\n\nThis API can be used for purposes such as deciding what language to present the application in.\n\nHere are some examples of return values of the various language and locale APIs with different configurations:\n\nOn Windows, given application locale is German, the regional format is Finnish (Finland), and the preferred system languages from most to least preferred are French (Canada), English (US), Simplified Chinese (China), Finnish, and Spanish (Latin America):\n\nOn macOS, given the application locale is German, the region is Finland, and the preferred system languages from most to least preferred are French (Canada), English (US), Simplified Chinese, and Spanish (Latin America):\n\nBoth the available languages and regions and the possible return values differ between the two operating systems.\n\nAs can be seen with the example above, on Windows, it is possible that a preferred system language has no country code, and that one of the preferred system languages corresponds with the language used for the regional format. On macOS, the region serves more as a default country code: the user doesn't need to have Finnish as a preferred language to use Finland as the region,and the country code `FI` is used as the country code for preferred system languages that do not have associated countries in the language name.",
|
|
463
463
|
"parameters": [],
|
|
464
464
|
"returns": {
|
|
465
465
|
"collection": true,
|
|
466
466
|
"type": "String",
|
|
467
|
-
"possibleValues":
|
|
468
|
-
{
|
|
469
|
-
"value": "app.getLocale()",
|
|
470
|
-
"description": ""
|
|
471
|
-
},
|
|
472
|
-
{
|
|
473
|
-
"value": "app.getSystemLocale()",
|
|
474
|
-
"description": "FI'`"
|
|
475
|
-
},
|
|
476
|
-
{
|
|
477
|
-
"value": "app.getPreferredSystemLanguages()",
|
|
478
|
-
"description": "CA', 'en-US', 'zh-Hans-CN', 'fi', 'es-419']`"
|
|
479
|
-
},
|
|
480
|
-
{
|
|
481
|
-
"value": "app.getLocale()",
|
|
482
|
-
"description": ""
|
|
483
|
-
},
|
|
484
|
-
{
|
|
485
|
-
"value": "app.getSystemLocale()",
|
|
486
|
-
"description": "FI'`"
|
|
487
|
-
},
|
|
488
|
-
{
|
|
489
|
-
"value": "app.getPreferredSystemLanguages()",
|
|
490
|
-
"description": "CA', 'en-US', 'zh-Hans-FI', 'es-419']`"
|
|
491
|
-
}
|
|
492
|
-
]
|
|
467
|
+
"possibleValues": null
|
|
493
468
|
},
|
|
494
469
|
"additionalTags": [],
|
|
495
470
|
"urlFragment": "#appgetpreferredsystemlanguages"
|
|
@@ -3025,8 +3000,8 @@
|
|
|
3025
3000
|
"description": "> Enable apps to automatically update themselves.\n\nProcess: Main\n\n**See also: A detailed guide about how to implement updates in your application.**\n\n`autoUpdater` is an EventEmitter.\n\n### Platform Notices\n\nCurrently, only macOS and Windows are supported. There is no built-in support for auto-updater on Linux, so it is recommended to use the distribution's package manager to update your app.\n\nIn addition, there are some subtle differences on each platform:\n\n### macOS\n\nOn macOS, the `autoUpdater` module is built upon Squirrel.Mac, meaning you don't need any special setup to make it work. For server-side requirements, you can read Server Support. Note that App Transport Security (ATS) applies to all requests made as part of the update process. Apps that need to disable ATS can add the `NSAllowsArbitraryLoads` key to their app's plist.\n\n**Note:** Your application must be signed for automatic updates on macOS. This is a requirement of `Squirrel.Mac`.\n\n### Windows\n\nOn Windows, you have to install your app into a user's machine before you can use the `autoUpdater`, so it is recommended that you use the electron-winstaller, Electron Forge or the grunt-electron-installer package to generate a Windows installer.\n\nWhen using electron-winstaller or Electron Forge make sure you do not try to update your app the first time it runs (Also see this issue for more info). It's also recommended to use electron-squirrel-startup to get desktop shortcuts for your app.\n\nThe installer generated with Squirrel will create a shortcut icon with an Application User Model ID in the format of `com.squirrel.PACKAGE_ID.YOUR_EXE_WITHOUT_DOT_EXE`, examples are `com.squirrel.slack.Slack` and `com.squirrel.code.Code`. You have to use the same ID for your app with `app.setAppUserModelId` API, otherwise Windows will not be able to pin your app properly in task bar.\n\nLike Squirrel.Mac, Windows can host updates on S3 or any other static file host. You can read the documents of Squirrel.Windows to get more details about how Squirrel.Windows works.",
|
|
3026
3001
|
"slug": "auto-updater",
|
|
3027
3002
|
"websiteUrl": "https://electronjs.org/docs/api/auto-updater",
|
|
3028
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
3029
|
-
"version": "22.3.
|
|
3003
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/auto-updater.md",
|
|
3004
|
+
"version": "22.3.13",
|
|
3030
3005
|
"type": "Module",
|
|
3031
3006
|
"process": {
|
|
3032
3007
|
"main": true,
|
|
@@ -3235,8 +3210,8 @@
|
|
|
3235
3210
|
"description": "A `BrowserView` can be used to embed additional web content into a `BrowserWindow`. It is like a child window, except that it is positioned relative to its owning window. It is meant to be an alternative to the `webview` tag.\n\n### Class: BrowserView\n\n> Create and control views.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Example\n\n```\n// In the main process.\nconst { app, BrowserView, BrowserWindow } = require('electron')\n\napp.whenReady().then(() => {\n const win = new BrowserWindow({ width: 800, height: 600 })\n\n const view = new BrowserView()\n win.setBrowserView(view)\n view.setBounds({ x: 0, y: 0, width: 300, height: 300 })\n view.webContents.loadURL('https://electronjs.org')\n})\n```",
|
|
3236
3211
|
"slug": "browser-view",
|
|
3237
3212
|
"websiteUrl": "https://electronjs.org/docs/api/browser-view",
|
|
3238
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
3239
|
-
"version": "22.3.
|
|
3213
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/browser-view.md",
|
|
3214
|
+
"version": "22.3.13",
|
|
3240
3215
|
"type": "Class",
|
|
3241
3216
|
"process": {
|
|
3242
3217
|
"main": true,
|
|
@@ -3397,8 +3372,8 @@
|
|
|
3397
3372
|
"description": "> Create and control browser windows.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Window customization\n\nThe `BrowserWindow` class exposes various ways to modify the look and behavior of your app's windows. For more details, see the Window Customization tutorial.\n\n### Showing the window gracefully\n\nWhen loading a page in the window directly, users may see the page load incrementally, which is not a good experience for a native app. To make the window display without a visual flash, there are two solutions for different situations.\n\n### Using the `ready-to-show` event\n\nWhile loading the page, the `ready-to-show` event will be emitted when the renderer process has rendered the page for the first time if the window has not been shown yet. Showing the window after this event will have no visual flash:\n\n```\nconst { BrowserWindow } = require('electron')\nconst win = new BrowserWindow({ show: false })\nwin.once('ready-to-show', () => {\n win.show()\n})\n```\n\nThis event is usually emitted after the `did-finish-load` event, but for pages with many remote resources, it may be emitted before the `did-finish-load` event.\n\nPlease note that using this event implies that the renderer will be considered \"visible\" and paint even though `show` is false. This event will never fire if you use `paintWhenInitiallyHidden: false`\n\n### Setting the `backgroundColor` property\n\nFor a complex app, the `ready-to-show` event could be emitted too late, making the app feel slow. In this case, it is recommended to show the window immediately, and use a `backgroundColor` close to your app's background:\n\n```\nconst { BrowserWindow } = require('electron')\n\nconst win = new BrowserWindow({ backgroundColor: '#2e2c29' })\nwin.loadURL('https://github.com')\n```\n\nNote that even for apps that use `ready-to-show` event, it is still recommended to set `backgroundColor` to make the app feel more native.\n\nSome examples of valid `backgroundColor` values include:\n\n```\nconst win = new BrowserWindow()\nwin.setBackgroundColor('hsl(230, 100%, 50%)')\nwin.setBackgroundColor('rgb(255, 145, 145)')\nwin.setBackgroundColor('#ff00a3')\nwin.setBackgroundColor('blueviolet')\n```\n\nFor more information about these color types see valid options in win.setBackgroundColor.\n\n### Parent and child windows\n\nBy using `parent` option, you can create child windows:\n\n```\nconst { BrowserWindow } = require('electron')\n\nconst top = new BrowserWindow()\nconst child = new BrowserWindow({ parent: top })\nchild.show()\ntop.show()\n```\n\nThe `child` window will always show on top of the `top` window.\n\n### Modal windows\n\nA modal window is a child window that disables parent window, to create a modal window, you have to set both `parent` and `modal` options:\n\n```\nconst { BrowserWindow } = require('electron')\n\nconst child = new BrowserWindow({ parent: top, modal: true, show: false })\nchild.loadURL('https://github.com')\nchild.once('ready-to-show', () => {\n child.show()\n})\n```\n\n### Page visibility\n\nThe Page Visibility API works as follows:\n\n* On all platforms, the visibility state tracks whether the window is hidden/minimized or not.\n* Additionally, on macOS, the visibility state also tracks the window occlusion state. If the window is occluded (i.e. fully covered) by another window, the visibility state will be `hidden`. On other platforms, the visibility state will be `hidden` only when the window is minimized or explicitly hidden with `win.hide()`.\n* If a `BrowserWindow` is created with `show: false`, the initial visibility state will be `visible` despite the window actually being hidden.\n* If `backgroundThrottling` is disabled, the visibility state will remain `visible` even if the window is minimized, occluded, or hidden.\n\nIt is recommended that you pause expensive operations when the visibility state is `hidden` in order to minimize power consumption.\n\n### Platform notices\n\n* On macOS modal windows will be displayed as sheets attached to the parent window.\n* On macOS the child windows will keep the relative position to parent window when parent window moves, while on Windows and Linux child windows will not move.\n* On Linux the type of modal windows will be changed to `dialog`.\n* On Linux many desktop environments do not support hiding a modal window.\n\n### Class: BrowserWindow\n\n> Create and control browser windows.\n\nProcess: Main\n\n`BrowserWindow` is an EventEmitter.\n\nIt creates a new `BrowserWindow` with native properties as set by the `options`.",
|
|
3398
3373
|
"slug": "browser-window",
|
|
3399
3374
|
"websiteUrl": "https://electronjs.org/docs/api/browser-window",
|
|
3400
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
3401
|
-
"version": "22.3.
|
|
3375
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/browser-window.md",
|
|
3376
|
+
"version": "22.3.13",
|
|
3402
3377
|
"type": "Class",
|
|
3403
3378
|
"process": {
|
|
3404
3379
|
"main": true,
|
|
@@ -7999,8 +7974,8 @@
|
|
|
7999
7974
|
"description": "> Make HTTP/HTTPS requests.\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._\n\n`ClientRequest` implements the Writable Stream interface and is therefore an EventEmitter.",
|
|
8000
7975
|
"slug": "client-request",
|
|
8001
7976
|
"websiteUrl": "https://electronjs.org/docs/api/client-request",
|
|
8002
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
8003
|
-
"version": "22.3.
|
|
7977
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/client-request.md",
|
|
7978
|
+
"version": "22.3.13",
|
|
8004
7979
|
"type": "Class",
|
|
8005
7980
|
"process": {
|
|
8006
7981
|
"main": true,
|
|
@@ -8596,8 +8571,8 @@
|
|
|
8596
8571
|
"description": "> Perform copy and paste operations on the system clipboard.\n\nProcess: Main, Renderer (non-sandboxed only)\n\nOn Linux, there is also a `selection` clipboard. To manipulate it you need to pass `selection` to each method:",
|
|
8597
8572
|
"slug": "clipboard",
|
|
8598
8573
|
"websiteUrl": "https://electronjs.org/docs/api/clipboard",
|
|
8599
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
8600
|
-
"version": "22.3.
|
|
8574
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/clipboard.md",
|
|
8575
|
+
"version": "22.3.13",
|
|
8601
8576
|
"type": "Module",
|
|
8602
8577
|
"process": {
|
|
8603
8578
|
"main": true,
|
|
@@ -9262,8 +9237,8 @@
|
|
|
9262
9237
|
"description": "",
|
|
9263
9238
|
"slug": "command-line",
|
|
9264
9239
|
"websiteUrl": "https://electronjs.org/docs/api/command-line",
|
|
9265
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
9266
|
-
"version": "22.3.
|
|
9240
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/command-line.md",
|
|
9241
|
+
"version": "22.3.13",
|
|
9267
9242
|
"type": "Class",
|
|
9268
9243
|
"process": {
|
|
9269
9244
|
"main": true,
|
|
@@ -9389,8 +9364,8 @@
|
|
|
9389
9364
|
"description": "> Collect tracing data from Chromium to find performance bottlenecks and slow operations.\n\nProcess: Main\n\nThis module does not include a web interface. To view recorded traces, use trace viewer, available at `chrome://tracing` in Chrome.\n\n**Note:** You should not use this module until the `ready` event of the app module is emitted.",
|
|
9390
9365
|
"slug": "content-tracing",
|
|
9391
9366
|
"websiteUrl": "https://electronjs.org/docs/api/content-tracing",
|
|
9392
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
9393
|
-
"version": "22.3.
|
|
9367
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/content-tracing.md",
|
|
9368
|
+
"version": "22.3.13",
|
|
9394
9369
|
"type": "Module",
|
|
9395
9370
|
"process": {
|
|
9396
9371
|
"main": true,
|
|
@@ -9526,8 +9501,8 @@
|
|
|
9526
9501
|
"description": "> Create a safe, bi-directional, synchronous bridge across isolated contexts\n\nProcess: Renderer\n\nAn example of exposing an API to a renderer from an isolated preload script is given below:\n\n```\n// Preload (Isolated World)\nconst { contextBridge, ipcRenderer } = require('electron')\n\ncontextBridge.exposeInMainWorld(\n 'electron',\n {\n doThing: () => ipcRenderer.send('do-a-thing')\n }\n)\n```\n\n### Glossary\n\n\n\n### Main World\n\nThe \"Main World\" is the JavaScript context that your main renderer code runs in. By default, the page you load in your renderer executes code in this world.\n\n### Isolated World\n\nWhen `contextIsolation` is enabled in your `webPreferences` (this is the default behavior since Electron 12.0.0), your `preload` scripts run in an \"Isolated World\". You can read more about context isolation and what it affects in the security docs.",
|
|
9527
9502
|
"slug": "context-bridge",
|
|
9528
9503
|
"websiteUrl": "https://electronjs.org/docs/api/context-bridge",
|
|
9529
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
9530
|
-
"version": "22.3.
|
|
9504
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/context-bridge.md",
|
|
9505
|
+
"version": "22.3.13",
|
|
9531
9506
|
"type": "Module",
|
|
9532
9507
|
"process": {
|
|
9533
9508
|
"main": false,
|
|
@@ -9602,8 +9577,8 @@
|
|
|
9602
9577
|
"description": "",
|
|
9603
9578
|
"slug": "cookies",
|
|
9604
9579
|
"websiteUrl": "https://electronjs.org/docs/api/cookies",
|
|
9605
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
9606
|
-
"version": "22.3.
|
|
9580
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/cookies.md",
|
|
9581
|
+
"version": "22.3.13",
|
|
9607
9582
|
"type": "Class",
|
|
9608
9583
|
"process": {
|
|
9609
9584
|
"main": true,
|
|
@@ -9939,8 +9914,8 @@
|
|
|
9939
9914
|
"description": "> Submit crash reports to a remote server.\n\nProcess: Main, Renderer\n\nThe following is an example of setting up Electron to automatically submit crash reports to a remote server:\n\n```\nconst { crashReporter } = require('electron')\n\ncrashReporter.start({ submitURL: 'https://your-domain.com/url-to-submit' })\n```\n\nFor setting up a server to accept and process crash reports, you can use following projects:\n\n* socorro\n* mini-breakpad-server\n\n> **Note:** Electron uses Crashpad, not Breakpad, to collect and upload crashes, but for the time being, the upload protocol is the same.\n\nOr use a 3rd party hosted solution:\n\n* Backtrace\n* Sentry\n* BugSplat\n* Bugsnag\n\nCrash reports are stored temporarily before being uploaded in a directory underneath the app's user data directory, called 'Crashpad'. You can override this directory by calling `app.setPath('crashDumps', '/path/to/crashes')` before starting the crash reporter.\n\nElectron uses crashpad to monitor and report crashes.",
|
|
9940
9915
|
"slug": "crash-reporter",
|
|
9941
9916
|
"websiteUrl": "https://electronjs.org/docs/api/crash-reporter",
|
|
9942
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
9943
|
-
"version": "22.3.
|
|
9917
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/crash-reporter.md",
|
|
9918
|
+
"version": "22.3.13",
|
|
9944
9919
|
"type": "Module",
|
|
9945
9920
|
"process": {
|
|
9946
9921
|
"main": true,
|
|
@@ -10202,8 +10177,8 @@
|
|
|
10202
10177
|
"description": "",
|
|
10203
10178
|
"slug": "debugger",
|
|
10204
10179
|
"websiteUrl": "https://electronjs.org/docs/api/debugger",
|
|
10205
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
10206
|
-
"version": "22.3.
|
|
10180
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/debugger.md",
|
|
10181
|
+
"version": "22.3.13",
|
|
10207
10182
|
"type": "Class",
|
|
10208
10183
|
"process": {
|
|
10209
10184
|
"main": true,
|
|
@@ -10367,8 +10342,8 @@
|
|
|
10367
10342
|
"description": "> Access information about media sources that can be used to capture audio and video from the desktop using the `navigator.mediaDevices.getUserMedia` API.\n\nProcess: Main\n\nThe following example shows how to capture video from a desktop window whose title is `Electron`:\n\n```\n// In the main process.\nconst { desktopCapturer } = require('electron')\n\ndesktopCapturer.getSources({ types: ['window', 'screen'] }).then(async sources => {\n for (const source of sources) {\n if (source.name === 'Electron') {\n mainWindow.webContents.send('SET_SOURCE', source.id)\n return\n }\n }\n})\n```\n\n```\n// In the preload script.\nconst { ipcRenderer } = require('electron')\n\nipcRenderer.on('SET_SOURCE', async (event, sourceId) => {\n try {\n const stream = await navigator.mediaDevices.getUserMedia({\n audio: false,\n video: {\n mandatory: {\n chromeMediaSource: 'desktop',\n chromeMediaSourceId: sourceId,\n minWidth: 1280,\n maxWidth: 1280,\n minHeight: 720,\n maxHeight: 720\n }\n }\n })\n handleStream(stream)\n } catch (e) {\n handleError(e)\n }\n})\n\nfunction handleStream (stream) {\n const video = document.querySelector('video')\n video.srcObject = stream\n video.onloadedmetadata = (e) => video.play()\n}\n\nfunction handleError (e) {\n console.log(e)\n}\n```\n\nTo capture video from a source provided by `desktopCapturer` the constraints passed to `navigator.mediaDevices.getUserMedia` must include `chromeMediaSource: 'desktop'`, and `audio: false`.\n\nTo capture both audio and video from the entire desktop the constraints passed to `navigator.mediaDevices.getUserMedia` must include `chromeMediaSource: 'desktop'`, for both `audio` and `video`, but should not include a `chromeMediaSourceId` constraint.",
|
|
10368
10343
|
"slug": "desktop-capturer",
|
|
10369
10344
|
"websiteUrl": "https://electronjs.org/docs/api/desktop-capturer",
|
|
10370
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
10371
|
-
"version": "22.3.
|
|
10345
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/desktop-capturer.md",
|
|
10346
|
+
"version": "22.3.13",
|
|
10372
10347
|
"type": "Module",
|
|
10373
10348
|
"process": {
|
|
10374
10349
|
"main": true,
|
|
@@ -10439,8 +10414,8 @@
|
|
|
10439
10414
|
"description": "> Display native system dialogs for opening and saving files, alerting, etc.\n\nProcess: Main\n\nAn example of showing a dialog to select multiple files:",
|
|
10440
10415
|
"slug": "dialog",
|
|
10441
10416
|
"websiteUrl": "https://electronjs.org/docs/api/dialog",
|
|
10442
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
10443
|
-
"version": "22.3.
|
|
10417
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/dialog.md",
|
|
10418
|
+
"version": "22.3.13",
|
|
10444
10419
|
"type": "Module",
|
|
10445
10420
|
"process": {
|
|
10446
10421
|
"main": true,
|
|
@@ -11488,8 +11463,8 @@
|
|
|
11488
11463
|
"description": "",
|
|
11489
11464
|
"slug": "dock",
|
|
11490
11465
|
"websiteUrl": "https://electronjs.org/docs/api/dock",
|
|
11491
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
11492
|
-
"version": "22.3.
|
|
11466
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/dock.md",
|
|
11467
|
+
"version": "22.3.13",
|
|
11493
11468
|
"type": "Class",
|
|
11494
11469
|
"process": {
|
|
11495
11470
|
"main": true,
|
|
@@ -11732,8 +11707,8 @@
|
|
|
11732
11707
|
"description": "",
|
|
11733
11708
|
"slug": "download-item",
|
|
11734
11709
|
"websiteUrl": "https://electronjs.org/docs/api/download-item",
|
|
11735
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
11736
|
-
"version": "22.3.
|
|
11710
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/download-item.md",
|
|
11711
|
+
"version": "22.3.13",
|
|
11737
11712
|
"type": "Class",
|
|
11738
11713
|
"process": {
|
|
11739
11714
|
"main": true,
|
|
@@ -12114,8 +12089,8 @@
|
|
|
12114
12089
|
"description": "> Detect keyboard events when the application does not have keyboard focus.\n\nProcess: Main\n\nThe `globalShortcut` module can register/unregister a global keyboard shortcut with the operating system so that you can customize the operations for various shortcuts.\n\n**Note:** The shortcut is global; it will work even if the app does not have the keyboard focus. This module cannot be used before the `ready` event of the app module is emitted.",
|
|
12115
12090
|
"slug": "global-shortcut",
|
|
12116
12091
|
"websiteUrl": "https://electronjs.org/docs/api/global-shortcut",
|
|
12117
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
12118
|
-
"version": "22.3.
|
|
12092
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/global-shortcut.md",
|
|
12093
|
+
"version": "22.3.13",
|
|
12119
12094
|
"type": "Module",
|
|
12120
12095
|
"process": {
|
|
12121
12096
|
"main": true,
|
|
@@ -12235,8 +12210,8 @@
|
|
|
12235
12210
|
"description": "> In-app purchases on Mac App Store.\n\nProcess: Main",
|
|
12236
12211
|
"slug": "in-app-purchase",
|
|
12237
12212
|
"websiteUrl": "https://electronjs.org/docs/api/in-app-purchase",
|
|
12238
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
12239
|
-
"version": "22.3.
|
|
12213
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/in-app-purchase.md",
|
|
12214
|
+
"version": "22.3.13",
|
|
12240
12215
|
"type": "Module",
|
|
12241
12216
|
"process": {
|
|
12242
12217
|
"main": true,
|
|
@@ -12384,8 +12359,8 @@
|
|
|
12384
12359
|
"description": "",
|
|
12385
12360
|
"slug": "incoming-message",
|
|
12386
12361
|
"websiteUrl": "https://electronjs.org/docs/api/incoming-message",
|
|
12387
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
12388
|
-
"version": "22.3.
|
|
12362
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/incoming-message.md",
|
|
12363
|
+
"version": "22.3.13",
|
|
12389
12364
|
"type": "Class",
|
|
12390
12365
|
"process": {
|
|
12391
12366
|
"main": true,
|
|
@@ -12531,8 +12506,8 @@
|
|
|
12531
12506
|
"description": "\n\n### ipcMain\n\n> Communicate asynchronously from the main process to renderer processes.\n\nProcess: Main\n\nThe `ipcMain` module is an Event Emitter. When used in the main process, it handles asynchronous and synchronous messages sent from a renderer process (web page). Messages sent from a renderer will be emitted to this module.\n\nFor usage examples, check out the IPC tutorial.\n\n### Sending messages\n\nIt is also possible to send messages from the main process to the renderer process, see webContents.send for more information.\n\n* When sending a message, the event name is the `channel`.\n* To reply to a synchronous message, you need to set `event.returnValue`.\n* To send an asynchronous message back to the sender, you can use `event.reply(...)`. This helper method will automatically handle messages coming from frames that aren't the main frame (e.g. iframes) whereas `event.sender.send(...)` will always send to the main frame.",
|
|
12532
12507
|
"slug": "ipc-main",
|
|
12533
12508
|
"websiteUrl": "https://electronjs.org/docs/api/ipc-main",
|
|
12534
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
12535
|
-
"version": "22.3.
|
|
12509
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/ipc-main.md",
|
|
12510
|
+
"version": "22.3.13",
|
|
12536
12511
|
"type": "Module",
|
|
12537
12512
|
"process": {
|
|
12538
12513
|
"main": true,
|
|
@@ -12825,8 +12800,8 @@
|
|
|
12825
12800
|
"description": "\n\n### ipcRenderer\n\n> Communicate asynchronously from a renderer process to the main process.\n\nProcess: Renderer\n\nThe `ipcRenderer` module is an EventEmitter. It provides a few methods so you can send synchronous and asynchronous messages from the render process (web page) to the main process. You can also receive replies from the main process.\n\nSee IPC tutorial for code examples.",
|
|
12826
12801
|
"slug": "ipc-renderer",
|
|
12827
12802
|
"websiteUrl": "https://electronjs.org/docs/api/ipc-renderer",
|
|
12828
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
12829
|
-
"version": "22.3.
|
|
12803
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/ipc-renderer.md",
|
|
12804
|
+
"version": "22.3.13",
|
|
12830
12805
|
"type": "Module",
|
|
12831
12806
|
"process": {
|
|
12832
12807
|
"main": false,
|
|
@@ -13157,8 +13132,8 @@
|
|
|
13157
13132
|
"description": "> Add items to native application menus and context menus.\n\nProcess: Main\n\nSee `Menu` for examples.",
|
|
13158
13133
|
"slug": "menu-item",
|
|
13159
13134
|
"websiteUrl": "https://electronjs.org/docs/api/menu-item",
|
|
13160
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
13161
|
-
"version": "22.3.
|
|
13135
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/menu-item.md",
|
|
13136
|
+
"version": "22.3.13",
|
|
13162
13137
|
"type": "Class",
|
|
13163
13138
|
"process": {
|
|
13164
13139
|
"main": true,
|
|
@@ -14045,8 +14020,8 @@
|
|
|
14045
14020
|
"description": "\n\n### Class: Menu\n\n> Create native application menus and context menus.\n\nProcess: Main",
|
|
14046
14021
|
"slug": "menu",
|
|
14047
14022
|
"websiteUrl": "https://electronjs.org/docs/api/menu",
|
|
14048
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
14049
|
-
"version": "22.3.
|
|
14023
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/menu.md",
|
|
14024
|
+
"version": "22.3.13",
|
|
14050
14025
|
"type": "Class",
|
|
14051
14026
|
"process": {
|
|
14052
14027
|
"main": true,
|
|
@@ -14359,8 +14334,8 @@
|
|
|
14359
14334
|
"description": "",
|
|
14360
14335
|
"slug": "message-channel-main",
|
|
14361
14336
|
"websiteUrl": "https://electronjs.org/docs/api/message-channel-main",
|
|
14362
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
14363
|
-
"version": "22.3.
|
|
14337
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/message-channel-main.md",
|
|
14338
|
+
"version": "22.3.13",
|
|
14364
14339
|
"type": "Class",
|
|
14365
14340
|
"process": {
|
|
14366
14341
|
"main": true,
|
|
@@ -14399,8 +14374,8 @@
|
|
|
14399
14374
|
"description": "",
|
|
14400
14375
|
"slug": "message-port-main",
|
|
14401
14376
|
"websiteUrl": "https://electronjs.org/docs/api/message-port-main",
|
|
14402
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
14403
|
-
"version": "22.3.
|
|
14377
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/message-port-main.md",
|
|
14378
|
+
"version": "22.3.13",
|
|
14404
14379
|
"type": "Class",
|
|
14405
14380
|
"process": {
|
|
14406
14381
|
"main": true,
|
|
@@ -14504,8 +14479,8 @@
|
|
|
14504
14479
|
"description": "> Create tray, dock, and application icons using PNG or JPG files.\n\nProcess: Main, Renderer\n\nIn Electron, for the APIs that take images, you can pass either file paths or `NativeImage` instances. An empty image will be used when `null` is passed.\n\nFor example, when creating a tray or setting a window's icon, you can pass an image file path as a `string`:\n\n```\nconst { BrowserWindow, Tray } = require('electron')\n\nconst appIcon = new Tray('/Users/somebody/images/icon.png')\nconst win = new BrowserWindow({ icon: '/Users/somebody/images/window.png' })\nconsole.log(appIcon, win)\n```\n\nOr read the image from the clipboard, which returns a `NativeImage`:\n\n### Supported Formats\n\nCurrently `PNG` and `JPEG` image formats are supported. `PNG` is recommended because of its support for transparency and lossless compression.\n\nOn Windows, you can also load `ICO` icons from file paths. For best visual quality, it is recommended to include at least the following sizes in the:\n\n* Small icon\n * 16x16 (100% DPI scale)\n * 20x20 (125% DPI scale)\n * 24x24 (150% DPI scale)\n * 32x32 (200% DPI scale)\n* Large icon\n * 32x32 (100% DPI scale)\n * 40x40 (125% DPI scale)\n * 48x48 (150% DPI scale)\n * 64x64 (200% DPI scale)\n * 256x256\n\nCheck the *Size requirements* section in this article.\n\n### High Resolution Image\n\nOn platforms that have high-DPI support such as Apple Retina displays, you can append `@2x` after image's base filename to mark it as a high resolution image.\n\nFor example, if `icon.png` is a normal image that has standard resolution, then `icon@2x.png` will be treated as a high resolution image that has double DPI density.\n\nIf you want to support displays with different DPI densities at the same time, you can put images with different sizes in the same folder and use the filename without DPI suffixes. For example:\n\n```\nimages/\n├── icon.png\n├── icon@2x.png\n└── icon@3x.png\n```\n\n```\nconst { Tray } = require('electron')\nconst appIcon = new Tray('/Users/somebody/images/icon.png')\nconsole.log(appIcon)\n```\n\nThe following suffixes for DPI are also supported:\n\n* `@1x`\n* `@1.25x`\n* `@1.33x`\n* `@1.4x`\n* `@1.5x`\n* `@1.8x`\n* `@2x`\n* `@2.5x`\n* `@3x`\n* `@4x`\n* `@5x`\n\n### Template Image\n\nTemplate images consist of black and an alpha channel. Template images are not intended to be used as standalone images and are usually mixed with other content to create the desired final appearance.\n\nThe most common case is to use template images for a menu bar icon, so it can adapt to both light and dark menu bars.\n\n**Note:** Template image is only supported on macOS.\n\nTo mark an image as a template image, its filename should end with the word `Template`. For example:\n\n* `xxxTemplate.png`\n* `xxxTemplate@2x.png`",
|
|
14505
14480
|
"slug": "native-image",
|
|
14506
14481
|
"websiteUrl": "https://electronjs.org/docs/api/native-image",
|
|
14507
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
14508
|
-
"version": "22.3.
|
|
14482
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/native-image.md",
|
|
14483
|
+
"version": "22.3.13",
|
|
14509
14484
|
"type": "Module",
|
|
14510
14485
|
"process": {
|
|
14511
14486
|
"main": true,
|
|
@@ -14750,8 +14725,8 @@
|
|
|
14750
14725
|
"description": "",
|
|
14751
14726
|
"slug": "native-image",
|
|
14752
14727
|
"websiteUrl": "https://electronjs.org/docs/api/native-image",
|
|
14753
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
14754
|
-
"version": "22.3.
|
|
14728
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/native-image.md",
|
|
14729
|
+
"version": "22.3.13",
|
|
14755
14730
|
"type": "Class",
|
|
14756
14731
|
"process": {
|
|
14757
14732
|
"main": true,
|
|
@@ -15159,8 +15134,8 @@
|
|
|
15159
15134
|
"description": "> Read and respond to changes in Chromium's native color theme.\n\nProcess: Main",
|
|
15160
15135
|
"slug": "native-theme",
|
|
15161
15136
|
"websiteUrl": "https://electronjs.org/docs/api/native-theme",
|
|
15162
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
15163
|
-
"version": "22.3.
|
|
15137
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/native-theme.md",
|
|
15138
|
+
"version": "22.3.13",
|
|
15164
15139
|
"type": "Module",
|
|
15165
15140
|
"process": {
|
|
15166
15141
|
"main": true,
|
|
@@ -15258,8 +15233,8 @@
|
|
|
15258
15233
|
"description": "> Logging network events for a session.\n\nProcess: Main\n\n```\nconst { netLog } = require('electron')\n\napp.whenReady().then(async () => {\n await netLog.startLogging('/path/to/net-log')\n // After some network events\n const path = await netLog.stopLogging()\n console.log('Net-logs written to', path)\n})\n```\n\nSee `--log-net-log` to log network events throughout the app's lifecycle.\n\n**Note:** All methods unless specified can only be used after the `ready` event of the `app` module gets emitted.",
|
|
15259
15234
|
"slug": "net-log",
|
|
15260
15235
|
"websiteUrl": "https://electronjs.org/docs/api/net-log",
|
|
15261
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
15262
|
-
"version": "22.3.
|
|
15236
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/net-log.md",
|
|
15237
|
+
"version": "22.3.13",
|
|
15263
15238
|
"type": "Module",
|
|
15264
15239
|
"process": {
|
|
15265
15240
|
"main": true,
|
|
@@ -15373,8 +15348,8 @@
|
|
|
15373
15348
|
"description": "> Issue HTTP/HTTPS requests using Chromium's native networking library\n\nProcess: Main\n\nThe `net` module is a client-side API for issuing HTTP(S) requests. It is similar to the HTTP and HTTPS modules of Node.js but uses Chromium's native networking library instead of the Node.js implementation, offering better support for web proxies. It also supports checking network status.\n\nThe following is a non-exhaustive list of why you may consider using the `net` module instead of the native Node.js modules:\n\n* Automatic management of system proxy configuration, support of the wpad protocol and proxy pac configuration files.\n* Automatic tunneling of HTTPS requests.\n* Support for authenticating proxies using basic, digest, NTLM, Kerberos or negotiate authentication schemes.\n* Support for traffic monitoring proxies: Fiddler-like proxies used for access control and monitoring.\n\nThe API components (including classes, methods, properties and event names) are similar to those used in Node.js.\n\nExample usage:\n\n```\nconst { app } = require('electron')\napp.whenReady().then(() => {\n const { net } = require('electron')\n const request = net.request('https://github.com')\n request.on('response', (response) => {\n console.log(`STATUS: ${response.statusCode}`)\n console.log(`HEADERS: ${JSON.stringify(response.headers)}`)\n response.on('data', (chunk) => {\n console.log(`BODY: ${chunk}`)\n })\n response.on('end', () => {\n console.log('No more data in response.')\n })\n })\n request.end()\n})\n```\n\nThe `net` API can be used only after the application emits the `ready` event. Trying to use the module before the `ready` event will throw an error.",
|
|
15374
15349
|
"slug": "net",
|
|
15375
15350
|
"websiteUrl": "https://electronjs.org/docs/api/net",
|
|
15376
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
15377
|
-
"version": "22.3.
|
|
15351
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/net.md",
|
|
15352
|
+
"version": "22.3.13",
|
|
15378
15353
|
"type": "Module",
|
|
15379
15354
|
"process": {
|
|
15380
15355
|
"main": true,
|
|
@@ -15446,8 +15421,8 @@
|
|
|
15446
15421
|
"description": "> Create OS desktop notifications\n\nProcess: Main\n\n### Using in the renderer process\n\nIf you want to show Notifications from a renderer process you should use the HTML5 Notification API\n\n### Class: Notification\n\n> Create OS desktop notifications\n\nProcess: Main\n\n`Notification` is an EventEmitter.\n\nIt creates a new `Notification` with native properties as set by the `options`.\n\n### Static Methods\n\nThe `Notification` class has the following static methods:\n\n### `Notification.isSupported()`\n\nReturns `boolean` - Whether or not desktop notifications are supported on the current system",
|
|
15447
15422
|
"slug": "notification",
|
|
15448
15423
|
"websiteUrl": "https://electronjs.org/docs/api/notification",
|
|
15449
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
15450
|
-
"version": "22.3.
|
|
15424
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/notification.md",
|
|
15425
|
+
"version": "22.3.13",
|
|
15451
15426
|
"type": "Class",
|
|
15452
15427
|
"process": {
|
|
15453
15428
|
"main": true,
|
|
@@ -15943,8 +15918,8 @@
|
|
|
15943
15918
|
"description": "> Interface for communication with parent process.\n\nProcess: Utility\n\n`parentPort` is an EventEmitter. _This object is not exported from the `'electron'` module. It is only available as a property of the process object in the Electron API._",
|
|
15944
15919
|
"slug": "parent-port",
|
|
15945
15920
|
"websiteUrl": "https://electronjs.org/docs/api/parent-port",
|
|
15946
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
15947
|
-
"version": "22.3.
|
|
15921
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/parent-port.md",
|
|
15922
|
+
"version": "22.3.13",
|
|
15948
15923
|
"type": "Module",
|
|
15949
15924
|
"process": {
|
|
15950
15925
|
"main": false,
|
|
@@ -16013,8 +15988,8 @@
|
|
|
16013
15988
|
"description": "> Monitor power state changes.\n\nProcess: Main",
|
|
16014
15989
|
"slug": "power-monitor",
|
|
16015
15990
|
"websiteUrl": "https://electronjs.org/docs/api/power-monitor",
|
|
16016
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
16017
|
-
"version": "22.3.
|
|
15991
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/power-monitor.md",
|
|
15992
|
+
"version": "22.3.13",
|
|
16018
15993
|
"type": "Module",
|
|
16019
15994
|
"process": {
|
|
16020
15995
|
"main": true,
|
|
@@ -16186,8 +16161,8 @@
|
|
|
16186
16161
|
"description": "> Block the system from entering low-power (sleep) mode.\n\nProcess: Main\n\nFor example:",
|
|
16187
16162
|
"slug": "power-save-blocker",
|
|
16188
16163
|
"websiteUrl": "https://electronjs.org/docs/api/power-save-blocker",
|
|
16189
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
16190
|
-
"version": "22.3.
|
|
16164
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/power-save-blocker.md",
|
|
16165
|
+
"version": "22.3.13",
|
|
16191
16166
|
"type": "Module",
|
|
16192
16167
|
"process": {
|
|
16193
16168
|
"main": true,
|
|
@@ -16272,8 +16247,8 @@
|
|
|
16272
16247
|
"description": "> Extensions to process object.\n\nProcess: Main, Renderer\n\nElectron's `process` object is extended from the Node.js `process` object. It adds the following events, properties, and methods:\n\n### Sandbox\n\nIn sandboxed renderers the `process` object contains only a subset of the APIs:\n\n* `crash()`\n* `hang()`\n* `getCreationTime()`\n* `getHeapStatistics()`\n* `getBlinkMemoryInfo()`\n* `getProcessMemoryInfo()`\n* `getSystemMemoryInfo()`\n* `getSystemVersion()`\n* `getCPUUsage()`\n* `getIOCounters()`\n* `uptime()`\n* `argv`\n* `execPath`\n* `env`\n* `pid`\n* `arch`\n* `platform`\n* `sandboxed`\n* `contextIsolated`\n* `type`\n* `version`\n* `versions`\n* `mas`\n* `windowsStore`\n* `contextId`",
|
|
16273
16248
|
"slug": "process",
|
|
16274
16249
|
"websiteUrl": "https://electronjs.org/docs/api/process",
|
|
16275
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
16276
|
-
"version": "22.3.
|
|
16250
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/process.md",
|
|
16251
|
+
"version": "22.3.13",
|
|
16277
16252
|
"type": "Module",
|
|
16278
16253
|
"process": {
|
|
16279
16254
|
"main": true,
|
|
@@ -16803,8 +16778,8 @@
|
|
|
16803
16778
|
"description": "> Register a custom protocol and intercept existing protocol requests.\n\nProcess: Main\n\nAn example of implementing a protocol that has the same effect as the `file://` protocol:\n\n```\nconst { app, protocol } = require('electron')\nconst path = require('path')\nconst url = require('url')\n\napp.whenReady().then(() => {\n protocol.registerFileProtocol('atom', (request, callback) => {\n const filePath = url.fileURLToPath('file://' + request.url.slice('atom://'.length))\n callback(filePath)\n })\n})\n```\n\n**Note:** All methods unless specified can only be used after the `ready` event of the `app` module gets emitted.\n\n### Using `protocol` with a custom `partition` or `session`\n\nA protocol is registered to a specific Electron `session` object. If you don't specify a session, then your `protocol` will be applied to the default session that Electron uses. However, if you define a `partition` or `session` on your `browserWindow`'s `webPreferences`, then that window will use a different session and your custom protocol will not work if you just use `electron.protocol.XXX`.\n\nTo have your custom protocol work in combination with a custom session, you need to register it to that session explicitly.\n\n```\nconst { session, app, protocol } = require('electron')\nconst path = require('path')\n\napp.whenReady().then(() => {\n const partition = 'persist:example'\n const ses = session.fromPartition(partition)\n\n ses.protocol.registerFileProtocol('atom', (request, callback) => {\n const url = request.url.substr(7)\n callback({ path: path.normalize(`${__dirname}/${url}`) })\n })\n\n mainWindow = new BrowserWindow({ webPreferences: { partition } })\n})\n```",
|
|
16804
16779
|
"slug": "protocol",
|
|
16805
16780
|
"websiteUrl": "https://electronjs.org/docs/api/protocol",
|
|
16806
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
16807
|
-
"version": "22.3.
|
|
16781
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/protocol.md",
|
|
16782
|
+
"version": "22.3.13",
|
|
16808
16783
|
"type": "Module",
|
|
16809
16784
|
"process": {
|
|
16810
16785
|
"main": true,
|
|
@@ -17549,8 +17524,8 @@
|
|
|
17549
17524
|
"description": "Process: Main\n\n> Register for and receive notifications from remote push notification services\n\nFor example, when registering for push notifications via Apple push notification services (APNS):",
|
|
17550
17525
|
"slug": "push-notifications",
|
|
17551
17526
|
"websiteUrl": "https://electronjs.org/docs/api/push-notifications",
|
|
17552
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
17553
|
-
"version": "22.3.
|
|
17527
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/push-notifications.md",
|
|
17528
|
+
"version": "22.3.13",
|
|
17554
17529
|
"type": "Module",
|
|
17555
17530
|
"process": {
|
|
17556
17531
|
"main": true,
|
|
@@ -17629,8 +17604,8 @@
|
|
|
17629
17604
|
"description": "> Allows access to simple encryption and decryption of strings for storage on the local machine.\n\nProcess: Main\n\nThis module protects data stored on disk from being accessed by other applications or users with full disk access.\n\nNote that on Mac, access to the system Keychain is required and these calls can block the current thread to collect user input. The same is true for Linux, if a password management tool is available.",
|
|
17630
17605
|
"slug": "safe-storage",
|
|
17631
17606
|
"websiteUrl": "https://electronjs.org/docs/api/safe-storage",
|
|
17632
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
17633
|
-
"version": "22.3.
|
|
17607
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/safe-storage.md",
|
|
17608
|
+
"version": "22.3.13",
|
|
17634
17609
|
"type": "Module",
|
|
17635
17610
|
"process": {
|
|
17636
17611
|
"main": true,
|
|
@@ -17702,8 +17677,8 @@
|
|
|
17702
17677
|
"description": "> Retrieve information about screen size, displays, cursor position, etc.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n`screen` is an EventEmitter.\n\n**Note:** In the renderer / DevTools, `window.screen` is a reserved DOM property, so writing `let { screen } = require('electron')` will not work.\n\nAn example of creating a window that fills the whole screen:\n\n```\nconst { app, BrowserWindow, screen } = require('electron')\n\nlet win\napp.whenReady().then(() => {\n const { width, height } = screen.getPrimaryDisplay().workAreaSize\n win = new BrowserWindow({ width, height })\n win.loadURL('https://github.com')\n})\n```\n\nAnother example of creating a window in the external display:",
|
|
17703
17678
|
"slug": "screen",
|
|
17704
17679
|
"websiteUrl": "https://electronjs.org/docs/api/screen",
|
|
17705
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
17706
|
-
"version": "22.3.
|
|
17680
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/screen.md",
|
|
17681
|
+
"version": "22.3.13",
|
|
17707
17682
|
"type": "Module",
|
|
17708
17683
|
"process": {
|
|
17709
17684
|
"main": true,
|
|
@@ -17992,8 +17967,8 @@
|
|
|
17992
17967
|
"description": "",
|
|
17993
17968
|
"slug": "service-workers",
|
|
17994
17969
|
"websiteUrl": "https://electronjs.org/docs/api/service-workers",
|
|
17995
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
17996
|
-
"version": "22.3.
|
|
17970
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/service-workers.md",
|
|
17971
|
+
"version": "22.3.13",
|
|
17997
17972
|
"type": "Class",
|
|
17998
17973
|
"process": {
|
|
17999
17974
|
"main": true,
|
|
@@ -18218,8 +18193,8 @@
|
|
|
18218
18193
|
"description": "> Manage browser sessions, cookies, cache, proxy settings, etc.\n\nProcess: Main\n\nThe `session` module can be used to create new `Session` objects.\n\nYou can also access the `session` of existing pages by using the `session` property of `WebContents`, or from the `session` module.",
|
|
18219
18194
|
"slug": "session",
|
|
18220
18195
|
"websiteUrl": "https://electronjs.org/docs/api/session",
|
|
18221
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
18222
|
-
"version": "22.3.
|
|
18196
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/session.md",
|
|
18197
|
+
"version": "22.3.13",
|
|
18223
18198
|
"type": "Module",
|
|
18224
18199
|
"process": {
|
|
18225
18200
|
"main": true,
|
|
@@ -18285,8 +18260,8 @@
|
|
|
18285
18260
|
"description": "",
|
|
18286
18261
|
"slug": "session",
|
|
18287
18262
|
"websiteUrl": "https://electronjs.org/docs/api/session",
|
|
18288
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
18289
|
-
"version": "22.3.
|
|
18263
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/session.md",
|
|
18264
|
+
"version": "22.3.13",
|
|
18290
18265
|
"type": "Class",
|
|
18291
18266
|
"process": {
|
|
18292
18267
|
"main": true,
|
|
@@ -20748,8 +20723,8 @@
|
|
|
20748
20723
|
"description": "The `ShareMenu` class creates Share Menu on macOS, which can be used to share information from the current context to apps, social media accounts, and other services.\n\nFor including the share menu as a submenu of other menus, please use the `shareMenu` role of `MenuItem`.\n\n### Class: ShareMenu\n\n> Create share menu on macOS.\n\nProcess: Main",
|
|
20749
20724
|
"slug": "share-menu",
|
|
20750
20725
|
"websiteUrl": "https://electronjs.org/docs/api/share-menu",
|
|
20751
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
20752
|
-
"version": "22.3.
|
|
20726
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/share-menu.md",
|
|
20727
|
+
"version": "22.3.13",
|
|
20753
20728
|
"type": "Class",
|
|
20754
20729
|
"process": {
|
|
20755
20730
|
"main": true,
|
|
@@ -20815,8 +20790,8 @@
|
|
|
20815
20790
|
"description": "> Manage files and URLs using their default applications.\n\nProcess: Main, Renderer (non-sandboxed only)\n\nThe `shell` module provides functions related to desktop integration.\n\nAn example of opening a URL in the user's default browser:\n\n```\nconst { shell } = require('electron')\n\nshell.openExternal('https://github.com')\n```\n\n**Note:** While the `shell` module can be used in the renderer process, it will not function in a sandboxed renderer.",
|
|
20816
20791
|
"slug": "shell",
|
|
20817
20792
|
"websiteUrl": "https://electronjs.org/docs/api/shell",
|
|
20818
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
20819
|
-
"version": "22.3.
|
|
20793
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/shell.md",
|
|
20794
|
+
"version": "22.3.13",
|
|
20820
20795
|
"type": "Module",
|
|
20821
20796
|
"process": {
|
|
20822
20797
|
"main": true,
|
|
@@ -21047,8 +21022,8 @@
|
|
|
21047
21022
|
"description": "> Get system preferences.\n\nProcess: Main",
|
|
21048
21023
|
"slug": "system-preferences",
|
|
21049
21024
|
"websiteUrl": "https://electronjs.org/docs/api/system-preferences",
|
|
21050
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
21051
|
-
"version": "22.3.
|
|
21025
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/system-preferences.md",
|
|
21026
|
+
"version": "22.3.13",
|
|
21052
21027
|
"type": "Module",
|
|
21053
21028
|
"process": {
|
|
21054
21029
|
"main": true,
|
|
@@ -22473,8 +22448,8 @@
|
|
|
22473
22448
|
"description": "> Create a button in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22474
22449
|
"slug": "touch-bar-button",
|
|
22475
22450
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-button",
|
|
22476
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
22477
|
-
"version": "22.3.
|
|
22451
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/touch-bar-button.md",
|
|
22452
|
+
"version": "22.3.13",
|
|
22478
22453
|
"type": "Class",
|
|
22479
22454
|
"process": {
|
|
22480
22455
|
"main": true,
|
|
@@ -22664,8 +22639,8 @@
|
|
|
22664
22639
|
"description": "> Create a color picker in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22665
22640
|
"slug": "touch-bar-color-picker",
|
|
22666
22641
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-color-picker",
|
|
22667
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
22668
|
-
"version": "22.3.
|
|
22642
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/touch-bar-color-picker.md",
|
|
22643
|
+
"version": "22.3.13",
|
|
22669
22644
|
"type": "Class",
|
|
22670
22645
|
"process": {
|
|
22671
22646
|
"main": true,
|
|
@@ -22756,8 +22731,8 @@
|
|
|
22756
22731
|
"description": "> Create a group in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22757
22732
|
"slug": "touch-bar-group",
|
|
22758
22733
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-group",
|
|
22759
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
22760
|
-
"version": "22.3.
|
|
22734
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/touch-bar-group.md",
|
|
22735
|
+
"version": "22.3.13",
|
|
22761
22736
|
"type": "Class",
|
|
22762
22737
|
"process": {
|
|
22763
22738
|
"main": true,
|
|
@@ -22798,8 +22773,8 @@
|
|
|
22798
22773
|
"description": "> Create a label in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22799
22774
|
"slug": "touch-bar-label",
|
|
22800
22775
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-label",
|
|
22801
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
22802
|
-
"version": "22.3.
|
|
22776
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/touch-bar-label.md",
|
|
22777
|
+
"version": "22.3.13",
|
|
22803
22778
|
"type": "Class",
|
|
22804
22779
|
"process": {
|
|
22805
22780
|
"main": true,
|
|
@@ -22890,8 +22865,8 @@
|
|
|
22890
22865
|
"description": "> Instantiates a special \"other items proxy\", which nests TouchBar elements inherited from Chromium at the space indicated by the proxy. By default, this proxy is added to each TouchBar at the end of the input. For more information, see the AppKit docs on NSTouchBarItemIdentifierOtherItemsProxy\n\nNote: Only one instance of this class can be added per TouchBar.\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22891
22866
|
"slug": "touch-bar-other-items-proxy",
|
|
22892
22867
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-other-items-proxy",
|
|
22893
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
22894
|
-
"version": "22.3.
|
|
22868
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/touch-bar-other-items-proxy.md",
|
|
22869
|
+
"version": "22.3.13",
|
|
22895
22870
|
"type": "Class",
|
|
22896
22871
|
"process": {
|
|
22897
22872
|
"main": true,
|
|
@@ -22914,8 +22889,8 @@
|
|
|
22914
22889
|
"description": "> Create a popover in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22915
22890
|
"slug": "touch-bar-popover",
|
|
22916
22891
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-popover",
|
|
22917
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
22918
|
-
"version": "22.3.
|
|
22892
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/touch-bar-popover.md",
|
|
22893
|
+
"version": "22.3.13",
|
|
22919
22894
|
"type": "Class",
|
|
22920
22895
|
"process": {
|
|
22921
22896
|
"main": true,
|
|
@@ -23001,8 +22976,8 @@
|
|
|
23001
22976
|
"description": "> Create a scrubber (a scrollable selector)\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23002
22977
|
"slug": "touch-bar-scrubber",
|
|
23003
22978
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-scrubber",
|
|
23004
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
23005
|
-
"version": "22.3.
|
|
22979
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/touch-bar-scrubber.md",
|
|
22980
|
+
"version": "22.3.13",
|
|
23006
22981
|
"type": "Class",
|
|
23007
22982
|
"process": {
|
|
23008
22983
|
"main": true,
|
|
@@ -23250,8 +23225,8 @@
|
|
|
23250
23225
|
"description": "> Create a segmented control (a button group) where one button has a selected state\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23251
23226
|
"slug": "touch-bar-segmented-control",
|
|
23252
23227
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-segmented-control",
|
|
23253
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
23254
|
-
"version": "22.3.
|
|
23228
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/touch-bar-segmented-control.md",
|
|
23229
|
+
"version": "22.3.13",
|
|
23255
23230
|
"type": "Class",
|
|
23256
23231
|
"process": {
|
|
23257
23232
|
"main": true,
|
|
@@ -23441,8 +23416,8 @@
|
|
|
23441
23416
|
"description": "> Create a slider in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23442
23417
|
"slug": "touch-bar-slider",
|
|
23443
23418
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-slider",
|
|
23444
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
23445
|
-
"version": "22.3.
|
|
23419
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/touch-bar-slider.md",
|
|
23420
|
+
"version": "22.3.13",
|
|
23446
23421
|
"type": "Class",
|
|
23447
23422
|
"process": {
|
|
23448
23423
|
"main": true,
|
|
@@ -23564,8 +23539,8 @@
|
|
|
23564
23539
|
"description": "> Create a spacer between two items in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23565
23540
|
"slug": "touch-bar-spacer",
|
|
23566
23541
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-spacer",
|
|
23567
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
23568
|
-
"version": "22.3.
|
|
23542
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/touch-bar-spacer.md",
|
|
23543
|
+
"version": "22.3.13",
|
|
23569
23544
|
"type": "Class",
|
|
23570
23545
|
"process": {
|
|
23571
23546
|
"main": true,
|
|
@@ -23644,8 +23619,8 @@
|
|
|
23644
23619
|
"description": "\n\n### Class: TouchBar\n\n> Create TouchBar layouts for native macOS applications\n\nProcess: Main",
|
|
23645
23620
|
"slug": "touch-bar",
|
|
23646
23621
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar",
|
|
23647
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
23648
|
-
"version": "22.3.
|
|
23622
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/touch-bar.md",
|
|
23623
|
+
"version": "22.3.13",
|
|
23649
23624
|
"type": "Class",
|
|
23650
23625
|
"process": {
|
|
23651
23626
|
"main": true,
|
|
@@ -23873,8 +23848,8 @@
|
|
|
23873
23848
|
"description": "\n\n### Class: Tray\n\n> Add icons and context menus to the system's notification area.\n\nProcess: Main\n\n`Tray` is an EventEmitter.\n\n```\nconst { app, Menu, Tray } = require('electron')\n\nlet tray = null\napp.whenReady().then(() => {\n tray = new Tray('/path/to/my/icon')\n const contextMenu = Menu.buildFromTemplate([\n { label: 'Item1', type: 'radio' },\n { label: 'Item2', type: 'radio' },\n { label: 'Item3', type: 'radio', checked: true },\n { label: 'Item4', type: 'radio' }\n ])\n tray.setToolTip('This is my application.')\n tray.setContextMenu(contextMenu)\n})\n```\n\n__Platform Considerations__\n\n__Linux__\n\n* Tray icon uses StatusNotifierItem by default, when it is not available in user's desktop environment the `GtkStatusIcon` will be used instead.\n* The `click` event is emitted when the tray icon receives activation from user, however the StatusNotifierItem spec does not specify which action would cause an activation, for some environments it is left mouse click, but for some it might be double left mouse click.\n* In order for changes made to individual `MenuItem`s to take effect, you have to call `setContextMenu` again. For example:\n\n```\nconst { app, Menu, Tray } = require('electron')\n\nlet appIcon = null\napp.whenReady().then(() => {\n appIcon = new Tray('/path/to/my/icon')\n const contextMenu = Menu.buildFromTemplate([\n { label: 'Item1', type: 'radio' },\n { label: 'Item2', type: 'radio' }\n ])\n\n // Make a change to the context menu\n contextMenu.items[1].checked = false\n\n // Call this again for Linux because we modified the context menu\n appIcon.setContextMenu(contextMenu)\n})\n```\n\n__MacOS__\n\n* Icons passed to the Tray constructor should be Template Images.\n* To make sure your icon isn't grainy on retina monitors, be sure your `@2x` image is 144dpi.\n* If you are bundling your application (e.g., with webpack for development), be sure that the file names are not being mangled or hashed. The filename needs to end in Template, and the `@2x` image needs to have the same filename as the standard image, or MacOS will not magically invert your image's colors or use the high density image.\n* 16x16 (72dpi) and 32x32@2x (144dpi) work well for most icons.\n\n__Windows__\n\n* It is recommended to use `ICO` icons to get best visual effects.",
|
|
23874
23849
|
"slug": "tray",
|
|
23875
23850
|
"websiteUrl": "https://electronjs.org/docs/api/tray",
|
|
23876
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
23877
|
-
"version": "22.3.
|
|
23851
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/tray.md",
|
|
23852
|
+
"version": "22.3.13",
|
|
23878
23853
|
"type": "Class",
|
|
23879
23854
|
"process": {
|
|
23880
23855
|
"main": true,
|
|
@@ -24641,8 +24616,8 @@
|
|
|
24641
24616
|
"description": "`utilityProcess` creates a child process with Node.js and Message ports enabled. It provides the equivalent of `child_process.fork` API from Node.js but instead uses Services API from Chromium to launch the child process.\n\nProcess: Main<br />",
|
|
24642
24617
|
"slug": "utility-process",
|
|
24643
24618
|
"websiteUrl": "https://electronjs.org/docs/api/utility-process",
|
|
24644
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
24645
|
-
"version": "22.3.
|
|
24619
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/utility-process.md",
|
|
24620
|
+
"version": "22.3.13",
|
|
24646
24621
|
"type": "Module",
|
|
24647
24622
|
"process": {
|
|
24648
24623
|
"main": true,
|
|
@@ -24776,8 +24751,8 @@
|
|
|
24776
24751
|
"description": "",
|
|
24777
24752
|
"slug": "utility-process",
|
|
24778
24753
|
"websiteUrl": "https://electronjs.org/docs/api/utility-process",
|
|
24779
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
24780
|
-
"version": "22.3.
|
|
24754
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/utility-process.md",
|
|
24755
|
+
"version": "22.3.13",
|
|
24781
24756
|
"type": "Class",
|
|
24782
24757
|
"process": {
|
|
24783
24758
|
"main": true,
|
|
@@ -24927,8 +24902,8 @@
|
|
|
24927
24902
|
"description": "> Render and control web pages.\n\nProcess: Main\n\n`webContents` is an EventEmitter. It is responsible for rendering and controlling a web page and is a property of the `BrowserWindow` object. An example of accessing the `webContents` object:",
|
|
24928
24903
|
"slug": "web-contents",
|
|
24929
24904
|
"websiteUrl": "https://electronjs.org/docs/api/web-contents",
|
|
24930
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
24931
|
-
"version": "22.3.
|
|
24905
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/web-contents.md",
|
|
24906
|
+
"version": "22.3.13",
|
|
24932
24907
|
"type": "Module",
|
|
24933
24908
|
"process": {
|
|
24934
24909
|
"main": true,
|
|
@@ -25031,8 +25006,8 @@
|
|
|
25031
25006
|
"description": "",
|
|
25032
25007
|
"slug": "web-contents",
|
|
25033
25008
|
"websiteUrl": "https://electronjs.org/docs/api/web-contents",
|
|
25034
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
25035
|
-
"version": "22.3.
|
|
25009
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/web-contents.md",
|
|
25010
|
+
"version": "22.3.13",
|
|
25036
25011
|
"type": "Class",
|
|
25037
25012
|
"process": {
|
|
25038
25013
|
"main": true,
|
|
@@ -29781,7 +29756,7 @@
|
|
|
29781
29756
|
},
|
|
29782
29757
|
{
|
|
29783
29758
|
"name": "select-bluetooth-device",
|
|
29784
|
-
"description": "Emitted when bluetooth device needs to be selected
|
|
29759
|
+
"description": "Emitted when a bluetooth device needs to be selected when a call to `navigator.bluetooth.requestDevice` is made. `callback` should be called with the `deviceId` of the device to be selected. Passing an empty string to `callback` will cancel the request.\n\nIf an event listener is not added for this event, or if `event.preventDefault` is not called when handling this event, the first available device will be automatically selected.\n\nDue to the nature of bluetooth, scanning for devices when `navigator.bluetooth.requestDevice` is called may take time and will cause `select-bluetooth-device` to fire multiple times until `callback` is called with either a device id or an empty string to cancel the request.",
|
|
29785
29760
|
"parameters": [
|
|
29786
29761
|
{
|
|
29787
29762
|
"name": "event",
|
|
@@ -30115,8 +30090,8 @@
|
|
|
30115
30090
|
"description": "> Control web pages and iframes.\n\nProcess: Main\n\nThe `webFrameMain` module can be used to lookup frames across existing `WebContents` instances. Navigation events are the common use case.\n\n```\nconst { BrowserWindow, webFrameMain } = require('electron')\n\nconst win = new BrowserWindow({ width: 800, height: 1500 })\nwin.loadURL('https://twitter.com')\n\nwin.webContents.on(\n 'did-frame-navigate',\n (event, url, httpResponseCode, httpStatusText, isMainFrame, frameProcessId, frameRoutingId) => {\n const frame = webFrameMain.fromId(frameProcessId, frameRoutingId)\n if (frame) {\n const code = 'document.body.innerHTML = document.body.innerHTML.replaceAll(\"heck\", \"h*ck\")'\n frame.executeJavaScript(code)\n }\n }\n)\n```\n\nYou can also access frames of existing pages by using the `mainFrame` property of `WebContents`.",
|
|
30116
30091
|
"slug": "web-frame-main",
|
|
30117
30092
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame-main",
|
|
30118
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
30119
|
-
"version": "22.3.
|
|
30093
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/web-frame-main.md",
|
|
30094
|
+
"version": "22.3.13",
|
|
30120
30095
|
"type": "Module",
|
|
30121
30096
|
"process": {
|
|
30122
30097
|
"main": true,
|
|
@@ -30170,8 +30145,8 @@
|
|
|
30170
30145
|
"description": "",
|
|
30171
30146
|
"slug": "web-frame-main",
|
|
30172
30147
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame-main",
|
|
30173
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
30174
|
-
"version": "22.3.
|
|
30148
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/web-frame-main.md",
|
|
30149
|
+
"version": "22.3.13",
|
|
30175
30150
|
"type": "Class",
|
|
30176
30151
|
"process": {
|
|
30177
30152
|
"main": true,
|
|
@@ -30469,8 +30444,8 @@
|
|
|
30469
30444
|
"description": "> Customize the rendering of the current web page.\n\nProcess: Renderer\n\n`webFrame` export of the Electron module is an instance of the `WebFrame` class representing the current frame. Sub-frames can be retrieved by certain properties and methods (e.g. `webFrame.firstChild`).\n\nAn example of zooming current page to 200%.",
|
|
30470
30445
|
"slug": "web-frame",
|
|
30471
30446
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame",
|
|
30472
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
30473
|
-
"version": "22.3.
|
|
30447
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/web-frame.md",
|
|
30448
|
+
"version": "22.3.13",
|
|
30474
30449
|
"type": "Module",
|
|
30475
30450
|
"process": {
|
|
30476
30451
|
"main": false,
|
|
@@ -31173,8 +31148,8 @@
|
|
|
31173
31148
|
"description": "",
|
|
31174
31149
|
"slug": "web-request",
|
|
31175
31150
|
"websiteUrl": "https://electronjs.org/docs/api/web-request",
|
|
31176
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
31177
|
-
"version": "22.3.
|
|
31151
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/web-request.md",
|
|
31152
|
+
"version": "22.3.13",
|
|
31178
31153
|
"type": "Class",
|
|
31179
31154
|
"process": {
|
|
31180
31155
|
"main": true,
|
|
@@ -33019,8 +32994,8 @@
|
|
|
33019
32994
|
"description": "\n\n### Warning\n\nElectron's `webview` tag is based on Chromium's `webview`, which is undergoing dramatic architectural changes. This impacts the stability of `webviews`, including rendering, navigation, and event routing. We currently recommend to not use the `webview` tag and to consider alternatives, like `iframe`, Electron's `BrowserView`, or an architecture that avoids embedded content altogether.\n\n### Enabling\n\nBy default the `webview` tag is disabled in Electron >= 5. You need to enable the tag by setting the `webviewTag` webPreferences option when constructing your `BrowserWindow`. For more information see the BrowserWindow constructor docs.\n\n### Overview\n\n> Display external web content in an isolated frame and process.\n\nProcess: Renderer<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._\n\nUse the `webview` tag to embed 'guest' content (such as web pages) in your Electron app. The guest content is contained within the `webview` container. An embedded page within your app controls how the guest content is laid out and rendered.\n\nUnlike an `iframe`, the `webview` runs in a separate process than your app. It doesn't have the same permissions as your web page and all interactions between your app and embedded content will be asynchronous. This keeps your app safe from the embedded content. **Note:** Most methods called on the webview from the host page require a synchronous call to the main process.\n\n### Example\n\nTo embed a web page in your app, add the `webview` tag to your app's embedder page (this is the app page that will display the guest content). In its simplest form, the `webview` tag includes the `src` of the web page and css styles that control the appearance of the `webview` container:\n\n```\n<webview id=\"foo\" src=\"https://www.github.com/\" style=\"display:inline-flex; width:640px; height:480px\"></webview>\n```\n\nIf you want to control the guest content in any way, you can write JavaScript that listens for `webview` events and responds to those events using the `webview` methods. Here's sample code with two event listeners: one that listens for the web page to start loading, the other for the web page to stop loading, and displays a \"loading...\" message during the load time:\n\n```\n<script>\n onload = () => {\n const webview = document.querySelector('webview')\n const indicator = document.querySelector('.indicator')\n\n const loadstart = () => {\n indicator.innerText = 'loading...'\n }\n\n const loadstop = () => {\n indicator.innerText = ''\n }\n\n webview.addEventListener('did-start-loading', loadstart)\n webview.addEventListener('did-stop-loading', loadstop)\n }\n</script>\n```\n\n### Internal implementation\n\nUnder the hood `webview` is implemented with Out-of-Process iframes (OOPIFs). The `webview` tag is essentially a custom element using shadow DOM to wrap an `iframe` element inside it.\n\nSo the behavior of `webview` is very similar to a cross-domain `iframe`, as examples:\n\n* When clicking into a `webview`, the page focus will move from the embedder frame to `webview`.\n* You can not add keyboard, mouse, and scroll event listeners to `webview`.\n* All reactions between the embedder frame and `webview` are asynchronous.\n\n### CSS Styling Notes\n\nPlease note that the `webview` tag's style uses `display:flex;` internally to ensure the child `iframe` element fills the full height and width of its `webview` container when used with traditional and flexbox layouts. Please do not overwrite the default `display:flex;` CSS property, unless specifying `display:inline-flex;` for inline layout.\n\n### Tag Attributes\n\nThe `webview` tag has the following attributes:\n\n### `src`\n\n```\n<webview src=\"https://www.github.com/\"></webview>\n```\n\nA `string` representing the visible URL. Writing to this attribute initiates top-level navigation.\n\nAssigning `src` its own value will reload the current page.\n\nThe `src` attribute can also accept data URLs, such as `data:text/plain,Hello, world!`.\n\n### `nodeintegration`\n\n```\n<webview src=\"http://www.google.com/\" nodeintegration></webview>\n```\n\nA `boolean`. When this attribute is present the guest page in `webview` will have node integration and can use node APIs like `require` and `process` to access low level system resources. Node integration is disabled by default in the guest page.\n\n### `nodeintegrationinsubframes`\n\n```\n<webview src=\"http://www.google.com/\" nodeintegrationinsubframes></webview>\n```\n\nA `boolean` for the experimental option for enabling NodeJS support in sub-frames such as iframes inside the `webview`. All your preloads will load for every iframe, you can use `process.isMainFrame` to determine if you are in the main frame or not. This option is disabled by default in the guest page.\n\n### `plugins`\n\n```\n<webview src=\"https://www.github.com/\" plugins></webview>\n```\n\nA `boolean`. When this attribute is present the guest page in `webview` will be able to use browser plugins. Plugins are disabled by default.\n\n### `preload`\n\n```\n<!-- from a file -->\n<webview src=\"https://www.github.com/\" preload=\"./test.js\"></webview>\n<!-- or if you want to load from an asar archive -->\n<webview src=\"https://www.github.com/\" preload=\"./app.asar/test.js\"></webview>\n```\n\nA `string` that specifies a script that will be loaded before other scripts run in the guest page. The protocol of script's URL must be `file:` (even when using `asar:` archives) because it will be loaded by Node's `require` under the hood, which treats `asar:` archives as virtual directories.\n\nWhen the guest page doesn't have node integration this script will still have access to all Node APIs, but global objects injected by Node will be deleted after this script has finished executing.\n\n### `httpreferrer`\n\n```\n<webview src=\"https://www.github.com/\" httpreferrer=\"http://cheng.guru\"></webview>\n```\n\nA `string` that sets the referrer URL for the guest page.\n\n### `useragent`\n\n```\n<webview src=\"https://www.github.com/\" useragent=\"Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; AS; rv:11.0) like Gecko\"></webview>\n```\n\nA `string` that sets the user agent for the guest page before the page is navigated to. Once the page is loaded, use the `setUserAgent` method to change the user agent.\n\n### `disablewebsecurity`\n\n```\n<webview src=\"https://www.github.com/\" disablewebsecurity></webview>\n```\n\nA `boolean`. When this attribute is present the guest page will have web security disabled. Web security is enabled by default.\n\n### `partition`\n\n```\n<webview src=\"https://github.com\" partition=\"persist:github\"></webview>\n<webview src=\"https://electronjs.org\" partition=\"electron\"></webview>\n```\n\nA `string` that sets the session used by the page. If `partition` starts with `persist:`, the page will use a persistent session available to all pages in the app with the same `partition`. if there is no `persist:` prefix, the page will use an in-memory session. By assigning the same `partition`, multiple pages can share the same session. If the `partition` is unset then default session of the app will be used.\n\nThis value can only be modified before the first navigation, since the session of an active renderer process cannot change. Subsequent attempts to modify the value will fail with a DOM exception.\n\n### `allowpopups`\n\n```\n<webview src=\"https://www.github.com/\" allowpopups></webview>\n```\n\nA `boolean`. When this attribute is present the guest page will be allowed to open new windows. Popups are disabled by default.\n\n### `webpreferences`\n\n```\n<webview src=\"https://github.com\" webpreferences=\"allowRunningInsecureContent, javascript=no\"></webview>\n```\n\nA `string` which is a comma separated list of strings which specifies the web preferences to be set on the webview. The full list of supported preference strings can be found in BrowserWindow.\n\nThe string follows the same format as the features string in `window.open`. A name by itself is given a `true` boolean value. A preference can be set to another value by including an `=`, followed by the value. Special values `yes` and `1` are interpreted as `true`, while `no` and `0` are interpreted as `false`.\n\n### `enableblinkfeatures`\n\n```\n<webview src=\"https://www.github.com/\" enableblinkfeatures=\"PreciseMemoryInfo, CSSVariables\"></webview>\n```\n\nA `string` which is a list of strings which specifies the blink features to be enabled separated by `,`. The full list of supported feature strings can be found in the RuntimeEnabledFeatures.json5 file.\n\n### `disableblinkfeatures`\n\n```\n<webview src=\"https://www.github.com/\" disableblinkfeatures=\"PreciseMemoryInfo, CSSVariables\"></webview>\n```\n\nA `string` which is a list of strings which specifies the blink features to be disabled separated by `,`. The full list of supported feature strings can be found in the RuntimeEnabledFeatures.json5 file.",
|
|
33020
32995
|
"slug": "webview-tag",
|
|
33021
32996
|
"websiteUrl": "https://electronjs.org/docs/api/webview-tag",
|
|
33022
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
33023
|
-
"version": "22.3.
|
|
32997
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/webview-tag.md",
|
|
32998
|
+
"version": "22.3.13",
|
|
33024
32999
|
"type": "Element",
|
|
33025
33000
|
"process": {
|
|
33026
33001
|
"main": false,
|
|
@@ -35715,8 +35690,8 @@
|
|
|
35715
35690
|
"description": "",
|
|
35716
35691
|
"slug": "bluetooth-device",
|
|
35717
35692
|
"websiteUrl": "https://electronjs.org/docs/api/structures/bluetooth-device",
|
|
35718
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
35719
|
-
"version": "22.3.
|
|
35693
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/bluetooth-device.md",
|
|
35694
|
+
"version": "22.3.13",
|
|
35720
35695
|
"properties": [
|
|
35721
35696
|
{
|
|
35722
35697
|
"name": "deviceName",
|
|
@@ -35744,8 +35719,8 @@
|
|
|
35744
35719
|
"description": "",
|
|
35745
35720
|
"slug": "certificate-principal",
|
|
35746
35721
|
"websiteUrl": "https://electronjs.org/docs/api/structures/certificate-principal",
|
|
35747
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
35748
|
-
"version": "22.3.
|
|
35722
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/certificate-principal.md",
|
|
35723
|
+
"version": "22.3.13",
|
|
35749
35724
|
"properties": [
|
|
35750
35725
|
{
|
|
35751
35726
|
"name": "commonName",
|
|
@@ -35809,8 +35784,8 @@
|
|
|
35809
35784
|
"description": "",
|
|
35810
35785
|
"slug": "certificate",
|
|
35811
35786
|
"websiteUrl": "https://electronjs.org/docs/api/structures/certificate",
|
|
35812
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
35813
|
-
"version": "22.3.
|
|
35787
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/certificate.md",
|
|
35788
|
+
"version": "22.3.13",
|
|
35814
35789
|
"properties": [
|
|
35815
35790
|
{
|
|
35816
35791
|
"name": "data",
|
|
@@ -35905,8 +35880,8 @@
|
|
|
35905
35880
|
"description": "",
|
|
35906
35881
|
"slug": "cookie",
|
|
35907
35882
|
"websiteUrl": "https://electronjs.org/docs/api/structures/cookie",
|
|
35908
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
35909
|
-
"version": "22.3.
|
|
35883
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/cookie.md",
|
|
35884
|
+
"version": "22.3.13",
|
|
35910
35885
|
"properties": [
|
|
35911
35886
|
{
|
|
35912
35887
|
"name": "name",
|
|
@@ -36018,8 +35993,8 @@
|
|
|
36018
35993
|
"description": "",
|
|
36019
35994
|
"slug": "cpu-usage",
|
|
36020
35995
|
"websiteUrl": "https://electronjs.org/docs/api/structures/cpu-usage",
|
|
36021
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36022
|
-
"version": "22.3.
|
|
35996
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/cpu-usage.md",
|
|
35997
|
+
"version": "22.3.13",
|
|
36023
35998
|
"properties": [
|
|
36024
35999
|
{
|
|
36025
36000
|
"name": "percentCPUUsage",
|
|
@@ -36045,8 +36020,8 @@
|
|
|
36045
36020
|
"description": "",
|
|
36046
36021
|
"slug": "crash-report",
|
|
36047
36022
|
"websiteUrl": "https://electronjs.org/docs/api/structures/crash-report",
|
|
36048
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36049
|
-
"version": "22.3.
|
|
36023
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/crash-report.md",
|
|
36024
|
+
"version": "22.3.13",
|
|
36050
36025
|
"properties": [
|
|
36051
36026
|
{
|
|
36052
36027
|
"name": "date",
|
|
@@ -36073,8 +36048,8 @@
|
|
|
36073
36048
|
"description": "",
|
|
36074
36049
|
"slug": "custom-scheme",
|
|
36075
36050
|
"websiteUrl": "https://electronjs.org/docs/api/structures/custom-scheme",
|
|
36076
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36077
|
-
"version": "22.3.
|
|
36051
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/custom-scheme.md",
|
|
36052
|
+
"version": "22.3.13",
|
|
36078
36053
|
"properties": [
|
|
36079
36054
|
{
|
|
36080
36055
|
"name": "scheme",
|
|
@@ -36159,8 +36134,8 @@
|
|
|
36159
36134
|
"description": "",
|
|
36160
36135
|
"slug": "desktop-capturer-source",
|
|
36161
36136
|
"websiteUrl": "https://electronjs.org/docs/api/structures/desktop-capturer-source",
|
|
36162
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36163
|
-
"version": "22.3.
|
|
36137
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/desktop-capturer-source.md",
|
|
36138
|
+
"version": "22.3.13",
|
|
36164
36139
|
"properties": [
|
|
36165
36140
|
{
|
|
36166
36141
|
"name": "id",
|
|
@@ -36213,8 +36188,8 @@
|
|
|
36213
36188
|
"description": "The `Display` object represents a physical display connected to the system. A fake `Display` may exist on a headless system, or a `Display` may correspond to a remote, virtual display.",
|
|
36214
36189
|
"slug": "display",
|
|
36215
36190
|
"websiteUrl": "https://electronjs.org/docs/api/structures/display",
|
|
36216
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36217
|
-
"version": "22.3.
|
|
36191
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/display.md",
|
|
36192
|
+
"version": "22.3.13",
|
|
36218
36193
|
"properties": [
|
|
36219
36194
|
{
|
|
36220
36195
|
"name": "id",
|
|
@@ -36383,8 +36358,8 @@
|
|
|
36383
36358
|
"description": "",
|
|
36384
36359
|
"slug": "event",
|
|
36385
36360
|
"websiteUrl": "https://electronjs.org/docs/api/structures/event",
|
|
36386
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36387
|
-
"version": "22.3.
|
|
36361
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/event.md",
|
|
36362
|
+
"version": "22.3.13",
|
|
36388
36363
|
"properties": [
|
|
36389
36364
|
{
|
|
36390
36365
|
"name": "preventDefault",
|
|
@@ -36402,8 +36377,8 @@
|
|
|
36402
36377
|
"description": "",
|
|
36403
36378
|
"slug": "extension-info",
|
|
36404
36379
|
"websiteUrl": "https://electronjs.org/docs/api/structures/extension-info",
|
|
36405
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36406
|
-
"version": "22.3.
|
|
36380
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/extension-info.md",
|
|
36381
|
+
"version": "22.3.13",
|
|
36407
36382
|
"properties": [
|
|
36408
36383
|
{
|
|
36409
36384
|
"name": "name",
|
|
@@ -36431,8 +36406,8 @@
|
|
|
36431
36406
|
"description": "",
|
|
36432
36407
|
"slug": "extension",
|
|
36433
36408
|
"websiteUrl": "https://electronjs.org/docs/api/structures/extension",
|
|
36434
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36435
|
-
"version": "22.3.
|
|
36409
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/extension.md",
|
|
36410
|
+
"version": "22.3.13",
|
|
36436
36411
|
"properties": [
|
|
36437
36412
|
{
|
|
36438
36413
|
"name": "id",
|
|
@@ -36495,8 +36470,8 @@
|
|
|
36495
36470
|
"description": "",
|
|
36496
36471
|
"slug": "file-filter",
|
|
36497
36472
|
"websiteUrl": "https://electronjs.org/docs/api/structures/file-filter",
|
|
36498
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36499
|
-
"version": "22.3.
|
|
36473
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/file-filter.md",
|
|
36474
|
+
"version": "22.3.13",
|
|
36500
36475
|
"properties": [
|
|
36501
36476
|
{
|
|
36502
36477
|
"name": "name",
|
|
@@ -36524,8 +36499,8 @@
|
|
|
36524
36499
|
"description": "",
|
|
36525
36500
|
"slug": "file-path-with-headers",
|
|
36526
36501
|
"websiteUrl": "https://electronjs.org/docs/api/structures/file-path-with-headers",
|
|
36527
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36528
|
-
"version": "22.3.
|
|
36502
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/file-path-with-headers.md",
|
|
36503
|
+
"version": "22.3.13",
|
|
36529
36504
|
"properties": [
|
|
36530
36505
|
{
|
|
36531
36506
|
"name": "path",
|
|
@@ -36564,8 +36539,8 @@
|
|
|
36564
36539
|
"description": "Possible values:\n\n* `disabled_software` - Software only. Hardware acceleration disabled (yellow)\n* `disabled_off` - Disabled (red)\n* `disabled_off_ok` - Disabled (yellow)\n* `unavailable_software` - Software only, hardware acceleration unavailable (yellow)\n* `unavailable_off` - Unavailable (red)\n* `unavailable_off_ok` - Unavailable (yellow)\n* `enabled_readback` - Hardware accelerated but at reduced performance (yellow)\n* `enabled_force` - Hardware accelerated on all pages (green)\n* `enabled` - Hardware accelerated (green)\n* `enabled_on` - Enabled (green)\n* `enabled_force_on` - Force enabled (green)",
|
|
36565
36540
|
"slug": "gpu-feature-status",
|
|
36566
36541
|
"websiteUrl": "https://electronjs.org/docs/api/structures/gpu-feature-status",
|
|
36567
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36568
|
-
"version": "22.3.
|
|
36542
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/gpu-feature-status.md",
|
|
36543
|
+
"version": "22.3.13",
|
|
36569
36544
|
"properties": [
|
|
36570
36545
|
{
|
|
36571
36546
|
"name": "2d_canvas",
|
|
@@ -36692,8 +36667,8 @@
|
|
|
36692
36667
|
"description": "",
|
|
36693
36668
|
"slug": "hid-device",
|
|
36694
36669
|
"websiteUrl": "https://electronjs.org/docs/api/structures/hid-device",
|
|
36695
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36696
|
-
"version": "22.3.
|
|
36670
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/hid-device.md",
|
|
36671
|
+
"version": "22.3.13",
|
|
36697
36672
|
"properties": [
|
|
36698
36673
|
{
|
|
36699
36674
|
"name": "deviceId",
|
|
@@ -36755,8 +36730,8 @@
|
|
|
36755
36730
|
"description": "",
|
|
36756
36731
|
"slug": "input-event",
|
|
36757
36732
|
"websiteUrl": "https://electronjs.org/docs/api/structures/input-event",
|
|
36758
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36759
|
-
"version": "22.3.
|
|
36733
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/input-event.md",
|
|
36734
|
+
"version": "22.3.13",
|
|
36760
36735
|
"properties": [
|
|
36761
36736
|
{
|
|
36762
36737
|
"name": "type",
|
|
@@ -37014,8 +36989,8 @@
|
|
|
37014
36989
|
"description": "",
|
|
37015
36990
|
"slug": "io-counters",
|
|
37016
36991
|
"websiteUrl": "https://electronjs.org/docs/api/structures/io-counters",
|
|
37017
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37018
|
-
"version": "22.3.
|
|
36992
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/io-counters.md",
|
|
36993
|
+
"version": "22.3.13",
|
|
37019
36994
|
"properties": [
|
|
37020
36995
|
{
|
|
37021
36996
|
"name": "readOperationCount",
|
|
@@ -37074,8 +37049,8 @@
|
|
|
37074
37049
|
"description": "",
|
|
37075
37050
|
"slug": "ipc-main-event",
|
|
37076
37051
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-event",
|
|
37077
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37078
|
-
"version": "22.3.
|
|
37052
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/ipc-main-event.md",
|
|
37053
|
+
"version": "22.3.13",
|
|
37079
37054
|
"properties": [
|
|
37080
37055
|
{
|
|
37081
37056
|
"name": "processId",
|
|
@@ -37162,8 +37137,8 @@
|
|
|
37162
37137
|
"description": "",
|
|
37163
37138
|
"slug": "ipc-main-invoke-event",
|
|
37164
37139
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-invoke-event",
|
|
37165
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37166
|
-
"version": "22.3.
|
|
37140
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/ipc-main-invoke-event.md",
|
|
37141
|
+
"version": "22.3.13",
|
|
37167
37142
|
"properties": [
|
|
37168
37143
|
{
|
|
37169
37144
|
"name": "processId",
|
|
@@ -37208,8 +37183,8 @@
|
|
|
37208
37183
|
"description": "",
|
|
37209
37184
|
"slug": "ipc-renderer-event",
|
|
37210
37185
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-renderer-event",
|
|
37211
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37212
|
-
"version": "22.3.
|
|
37186
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/ipc-renderer-event.md",
|
|
37187
|
+
"version": "22.3.13",
|
|
37213
37188
|
"properties": [
|
|
37214
37189
|
{
|
|
37215
37190
|
"name": "sender",
|
|
@@ -37243,8 +37218,8 @@
|
|
|
37243
37218
|
"description": "**Note:** If a `JumpListCategory` object has neither the `type` nor the `name` property set then its `type` is assumed to be `tasks`. If the `name` property is set but the `type` property is omitted then the `type` is assumed to be `custom`.\n\n**Note:** The maximum length of a Jump List item's `description` property is 260 characters. Beyond this limit, the item will not be added to the Jump List, nor will it be displayed.",
|
|
37244
37219
|
"slug": "jump-list-category",
|
|
37245
37220
|
"websiteUrl": "https://electronjs.org/docs/api/structures/jump-list-category",
|
|
37246
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37247
|
-
"version": "22.3.
|
|
37221
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/jump-list-category.md",
|
|
37222
|
+
"version": "22.3.13",
|
|
37248
37223
|
"properties": [
|
|
37249
37224
|
{
|
|
37250
37225
|
"name": "type",
|
|
@@ -37297,8 +37272,8 @@
|
|
|
37297
37272
|
"description": "",
|
|
37298
37273
|
"slug": "jump-list-item",
|
|
37299
37274
|
"websiteUrl": "https://electronjs.org/docs/api/structures/jump-list-item",
|
|
37300
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37301
|
-
"version": "22.3.
|
|
37275
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/jump-list-item.md",
|
|
37276
|
+
"version": "22.3.13",
|
|
37302
37277
|
"properties": [
|
|
37303
37278
|
{
|
|
37304
37279
|
"name": "type",
|
|
@@ -37401,8 +37376,8 @@
|
|
|
37401
37376
|
"description": "",
|
|
37402
37377
|
"slug": "keyboard-event",
|
|
37403
37378
|
"websiteUrl": "https://electronjs.org/docs/api/structures/keyboard-event",
|
|
37404
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37405
|
-
"version": "22.3.
|
|
37379
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/keyboard-event.md",
|
|
37380
|
+
"version": "22.3.13",
|
|
37406
37381
|
"properties": [
|
|
37407
37382
|
{
|
|
37408
37383
|
"name": "ctrlKey",
|
|
@@ -37453,8 +37428,8 @@
|
|
|
37453
37428
|
"description": "",
|
|
37454
37429
|
"slug": "keyboard-input-event",
|
|
37455
37430
|
"websiteUrl": "https://electronjs.org/docs/api/structures/keyboard-input-event",
|
|
37456
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37457
|
-
"version": "22.3.
|
|
37431
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/keyboard-input-event.md",
|
|
37432
|
+
"version": "22.3.13",
|
|
37458
37433
|
"properties": [
|
|
37459
37434
|
{
|
|
37460
37435
|
"name": "type",
|
|
@@ -37499,8 +37474,8 @@
|
|
|
37499
37474
|
"description": "Note that all statistics are reported in Kilobytes.",
|
|
37500
37475
|
"slug": "memory-info",
|
|
37501
37476
|
"websiteUrl": "https://electronjs.org/docs/api/structures/memory-info",
|
|
37502
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37503
|
-
"version": "22.3.
|
|
37477
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/memory-info.md",
|
|
37478
|
+
"version": "22.3.13",
|
|
37504
37479
|
"properties": [
|
|
37505
37480
|
{
|
|
37506
37481
|
"name": "workingSetSize",
|
|
@@ -37536,8 +37511,8 @@
|
|
|
37536
37511
|
"description": "",
|
|
37537
37512
|
"slug": "memory-usage-details",
|
|
37538
37513
|
"websiteUrl": "https://electronjs.org/docs/api/structures/memory-usage-details",
|
|
37539
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37540
|
-
"version": "22.3.
|
|
37514
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/memory-usage-details.md",
|
|
37515
|
+
"version": "22.3.13",
|
|
37541
37516
|
"properties": [
|
|
37542
37517
|
{
|
|
37543
37518
|
"name": "count",
|
|
@@ -37571,8 +37546,8 @@
|
|
|
37571
37546
|
"description": "",
|
|
37572
37547
|
"slug": "mime-typed-buffer",
|
|
37573
37548
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mime-typed-buffer",
|
|
37574
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37575
|
-
"version": "22.3.
|
|
37549
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/mime-typed-buffer.md",
|
|
37550
|
+
"version": "22.3.13",
|
|
37576
37551
|
"properties": [
|
|
37577
37552
|
{
|
|
37578
37553
|
"name": "mimeType",
|
|
@@ -37609,8 +37584,8 @@
|
|
|
37609
37584
|
"description": "",
|
|
37610
37585
|
"slug": "mouse-input-event",
|
|
37611
37586
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mouse-input-event",
|
|
37612
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37613
|
-
"version": "22.3.
|
|
37587
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/mouse-input-event.md",
|
|
37588
|
+
"version": "22.3.13",
|
|
37614
37589
|
"properties": [
|
|
37615
37590
|
{
|
|
37616
37591
|
"name": "type",
|
|
@@ -37737,8 +37712,8 @@
|
|
|
37737
37712
|
"description": "",
|
|
37738
37713
|
"slug": "mouse-wheel-input-event",
|
|
37739
37714
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mouse-wheel-input-event",
|
|
37740
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37741
|
-
"version": "22.3.
|
|
37715
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/mouse-wheel-input-event.md",
|
|
37716
|
+
"version": "22.3.13",
|
|
37742
37717
|
"properties": [
|
|
37743
37718
|
{
|
|
37744
37719
|
"name": "type",
|
|
@@ -37826,8 +37801,8 @@
|
|
|
37826
37801
|
"description": "",
|
|
37827
37802
|
"slug": "notification-action",
|
|
37828
37803
|
"websiteUrl": "https://electronjs.org/docs/api/structures/notification-action",
|
|
37829
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37830
|
-
"version": "22.3.
|
|
37804
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/notification-action.md",
|
|
37805
|
+
"version": "22.3.13",
|
|
37831
37806
|
"properties": [
|
|
37832
37807
|
{
|
|
37833
37808
|
"name": "type",
|
|
@@ -37860,8 +37835,8 @@
|
|
|
37860
37835
|
"description": "",
|
|
37861
37836
|
"slug": "notification-response",
|
|
37862
37837
|
"websiteUrl": "https://electronjs.org/docs/api/structures/notification-response",
|
|
37863
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37864
|
-
"version": "22.3.
|
|
37838
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/notification-response.md",
|
|
37839
|
+
"version": "22.3.13",
|
|
37865
37840
|
"properties": [
|
|
37866
37841
|
{
|
|
37867
37842
|
"name": "actionIdentifier",
|
|
@@ -37925,8 +37900,8 @@
|
|
|
37925
37900
|
"description": "",
|
|
37926
37901
|
"slug": "payment-discount",
|
|
37927
37902
|
"websiteUrl": "https://electronjs.org/docs/api/structures/payment-discount",
|
|
37928
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37929
|
-
"version": "22.3.
|
|
37903
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/payment-discount.md",
|
|
37904
|
+
"version": "22.3.13",
|
|
37930
37905
|
"properties": [
|
|
37931
37906
|
{
|
|
37932
37907
|
"name": "identifier",
|
|
@@ -37980,8 +37955,8 @@
|
|
|
37980
37955
|
"description": "**Note:** Both `x` and `y` must be whole integers, when providing a point object as input to an Electron API we will automatically round your `x` and `y` values to the nearest whole integer.",
|
|
37981
37956
|
"slug": "point",
|
|
37982
37957
|
"websiteUrl": "https://electronjs.org/docs/api/structures/point",
|
|
37983
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37984
|
-
"version": "22.3.
|
|
37958
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/point.md",
|
|
37959
|
+
"version": "22.3.13",
|
|
37985
37960
|
"properties": [
|
|
37986
37961
|
{
|
|
37987
37962
|
"name": "x",
|
|
@@ -38007,8 +37982,8 @@
|
|
|
38007
37982
|
"description": "",
|
|
38008
37983
|
"slug": "post-body",
|
|
38009
37984
|
"websiteUrl": "https://electronjs.org/docs/api/structures/post-body",
|
|
38010
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38011
|
-
"version": "22.3.
|
|
37985
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/post-body.md",
|
|
37986
|
+
"version": "22.3.13",
|
|
38012
37987
|
"properties": [
|
|
38013
37988
|
{
|
|
38014
37989
|
"name": "data",
|
|
@@ -38053,8 +38028,8 @@
|
|
|
38053
38028
|
"description": "",
|
|
38054
38029
|
"slug": "printer-info",
|
|
38055
38030
|
"websiteUrl": "https://electronjs.org/docs/api/structures/printer-info",
|
|
38056
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38057
|
-
"version": "22.3.
|
|
38031
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/printer-info.md",
|
|
38032
|
+
"version": "22.3.13",
|
|
38058
38033
|
"properties": [
|
|
38059
38034
|
{
|
|
38060
38035
|
"name": "name",
|
|
@@ -38116,8 +38091,8 @@
|
|
|
38116
38091
|
"description": "",
|
|
38117
38092
|
"slug": "process-memory-info",
|
|
38118
38093
|
"websiteUrl": "https://electronjs.org/docs/api/structures/process-memory-info",
|
|
38119
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38120
|
-
"version": "22.3.
|
|
38094
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/process-memory-info.md",
|
|
38095
|
+
"version": "22.3.13",
|
|
38121
38096
|
"properties": [
|
|
38122
38097
|
{
|
|
38123
38098
|
"name": "residentSet",
|
|
@@ -38154,8 +38129,8 @@
|
|
|
38154
38129
|
"description": "",
|
|
38155
38130
|
"slug": "process-metric",
|
|
38156
38131
|
"websiteUrl": "https://electronjs.org/docs/api/structures/process-metric",
|
|
38157
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38158
|
-
"version": "22.3.
|
|
38132
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/process-metric.md",
|
|
38133
|
+
"version": "22.3.13",
|
|
38159
38134
|
"properties": [
|
|
38160
38135
|
{
|
|
38161
38136
|
"name": "pid",
|
|
@@ -38304,8 +38279,8 @@
|
|
|
38304
38279
|
"description": "",
|
|
38305
38280
|
"slug": "product-discount",
|
|
38306
38281
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product-discount",
|
|
38307
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38308
|
-
"version": "22.3.
|
|
38282
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/product-discount.md",
|
|
38283
|
+
"version": "22.3.13",
|
|
38309
38284
|
"properties": [
|
|
38310
38285
|
{
|
|
38311
38286
|
"name": "identifier",
|
|
@@ -38387,8 +38362,8 @@
|
|
|
38387
38362
|
"description": "",
|
|
38388
38363
|
"slug": "product-subscription-period",
|
|
38389
38364
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product-subscription-period",
|
|
38390
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38391
|
-
"version": "22.3.
|
|
38365
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/product-subscription-period.md",
|
|
38366
|
+
"version": "22.3.13",
|
|
38392
38367
|
"properties": [
|
|
38393
38368
|
{
|
|
38394
38369
|
"name": "numberOfUnits",
|
|
@@ -38432,8 +38407,8 @@
|
|
|
38432
38407
|
"description": "",
|
|
38433
38408
|
"slug": "product",
|
|
38434
38409
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product",
|
|
38435
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38436
|
-
"version": "22.3.
|
|
38410
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/product.md",
|
|
38411
|
+
"version": "22.3.13",
|
|
38437
38412
|
"properties": [
|
|
38438
38413
|
{
|
|
38439
38414
|
"name": "productIdentifier",
|
|
@@ -38571,8 +38546,8 @@
|
|
|
38571
38546
|
"description": "",
|
|
38572
38547
|
"slug": "protocol-request",
|
|
38573
38548
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-request",
|
|
38574
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38575
|
-
"version": "22.3.
|
|
38549
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/protocol-request.md",
|
|
38550
|
+
"version": "22.3.13",
|
|
38576
38551
|
"properties": [
|
|
38577
38552
|
{
|
|
38578
38553
|
"name": "url",
|
|
@@ -38637,8 +38612,8 @@
|
|
|
38637
38612
|
"description": "",
|
|
38638
38613
|
"slug": "protocol-response-upload-data",
|
|
38639
38614
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-response-upload-data",
|
|
38640
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38641
|
-
"version": "22.3.
|
|
38615
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/protocol-response-upload-data.md",
|
|
38616
|
+
"version": "22.3.13",
|
|
38642
38617
|
"properties": [
|
|
38643
38618
|
{
|
|
38644
38619
|
"name": "contentType",
|
|
@@ -38675,8 +38650,8 @@
|
|
|
38675
38650
|
"description": "",
|
|
38676
38651
|
"slug": "protocol-response",
|
|
38677
38652
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-response",
|
|
38678
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38679
|
-
"version": "22.3.
|
|
38653
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/protocol-response.md",
|
|
38654
|
+
"version": "22.3.13",
|
|
38680
38655
|
"properties": [
|
|
38681
38656
|
{
|
|
38682
38657
|
"name": "error",
|
|
@@ -38824,8 +38799,8 @@
|
|
|
38824
38799
|
"description": "",
|
|
38825
38800
|
"slug": "rectangle",
|
|
38826
38801
|
"websiteUrl": "https://electronjs.org/docs/api/structures/rectangle",
|
|
38827
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38828
|
-
"version": "22.3.
|
|
38802
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/rectangle.md",
|
|
38803
|
+
"version": "22.3.13",
|
|
38829
38804
|
"properties": [
|
|
38830
38805
|
{
|
|
38831
38806
|
"name": "x",
|
|
@@ -38867,8 +38842,8 @@
|
|
|
38867
38842
|
"description": "",
|
|
38868
38843
|
"slug": "referrer",
|
|
38869
38844
|
"websiteUrl": "https://electronjs.org/docs/api/structures/referrer",
|
|
38870
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38871
|
-
"version": "22.3.
|
|
38845
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/referrer.md",
|
|
38846
|
+
"version": "22.3.13",
|
|
38872
38847
|
"properties": [
|
|
38873
38848
|
{
|
|
38874
38849
|
"name": "url",
|
|
@@ -38929,8 +38904,8 @@
|
|
|
38929
38904
|
"description": "",
|
|
38930
38905
|
"slug": "scrubber-item",
|
|
38931
38906
|
"websiteUrl": "https://electronjs.org/docs/api/structures/scrubber-item",
|
|
38932
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38933
|
-
"version": "22.3.
|
|
38907
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/scrubber-item.md",
|
|
38908
|
+
"version": "22.3.13",
|
|
38934
38909
|
"properties": [
|
|
38935
38910
|
{
|
|
38936
38911
|
"name": "label",
|
|
@@ -38957,8 +38932,8 @@
|
|
|
38957
38932
|
"description": "",
|
|
38958
38933
|
"slug": "segmented-control-segment",
|
|
38959
38934
|
"websiteUrl": "https://electronjs.org/docs/api/structures/segmented-control-segment",
|
|
38960
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38961
|
-
"version": "22.3.
|
|
38935
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/segmented-control-segment.md",
|
|
38936
|
+
"version": "22.3.13",
|
|
38962
38937
|
"properties": [
|
|
38963
38938
|
{
|
|
38964
38939
|
"name": "label",
|
|
@@ -38993,8 +38968,8 @@
|
|
|
38993
38968
|
"description": "",
|
|
38994
38969
|
"slug": "serial-port",
|
|
38995
38970
|
"websiteUrl": "https://electronjs.org/docs/api/structures/serial-port",
|
|
38996
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38997
|
-
"version": "22.3.
|
|
38971
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/serial-port.md",
|
|
38972
|
+
"version": "22.3.13",
|
|
38998
38973
|
"properties": [
|
|
38999
38974
|
{
|
|
39000
38975
|
"name": "portId",
|
|
@@ -39076,8 +39051,8 @@
|
|
|
39076
39051
|
"description": "",
|
|
39077
39052
|
"slug": "service-worker-info",
|
|
39078
39053
|
"websiteUrl": "https://electronjs.org/docs/api/structures/service-worker-info",
|
|
39079
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39080
|
-
"version": "22.3.
|
|
39054
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/service-worker-info.md",
|
|
39055
|
+
"version": "22.3.13",
|
|
39081
39056
|
"properties": [
|
|
39082
39057
|
{
|
|
39083
39058
|
"name": "scriptUrl",
|
|
@@ -39113,8 +39088,8 @@
|
|
|
39113
39088
|
"description": "",
|
|
39114
39089
|
"slug": "shared-worker-info",
|
|
39115
39090
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shared-worker-info",
|
|
39116
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39117
|
-
"version": "22.3.
|
|
39091
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/shared-worker-info.md",
|
|
39092
|
+
"version": "22.3.13",
|
|
39118
39093
|
"properties": [
|
|
39119
39094
|
{
|
|
39120
39095
|
"name": "id",
|
|
@@ -39142,8 +39117,8 @@
|
|
|
39142
39117
|
"description": "",
|
|
39143
39118
|
"slug": "sharing-item",
|
|
39144
39119
|
"websiteUrl": "https://electronjs.org/docs/api/structures/sharing-item",
|
|
39145
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39146
|
-
"version": "22.3.
|
|
39120
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/sharing-item.md",
|
|
39121
|
+
"version": "22.3.13",
|
|
39147
39122
|
"properties": [
|
|
39148
39123
|
{
|
|
39149
39124
|
"name": "texts",
|
|
@@ -39180,8 +39155,8 @@
|
|
|
39180
39155
|
"description": "",
|
|
39181
39156
|
"slug": "shortcut-details",
|
|
39182
39157
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shortcut-details",
|
|
39183
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39184
|
-
"version": "22.3.
|
|
39158
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/shortcut-details.md",
|
|
39159
|
+
"version": "22.3.13",
|
|
39185
39160
|
"properties": [
|
|
39186
39161
|
{
|
|
39187
39162
|
"name": "target",
|
|
@@ -39262,8 +39237,8 @@
|
|
|
39262
39237
|
"description": "",
|
|
39263
39238
|
"slug": "size",
|
|
39264
39239
|
"websiteUrl": "https://electronjs.org/docs/api/structures/size",
|
|
39265
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39266
|
-
"version": "22.3.
|
|
39240
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/size.md",
|
|
39241
|
+
"version": "22.3.13",
|
|
39267
39242
|
"properties": [
|
|
39268
39243
|
{
|
|
39269
39244
|
"name": "width",
|
|
@@ -39289,8 +39264,8 @@
|
|
|
39289
39264
|
"description": "",
|
|
39290
39265
|
"slug": "task",
|
|
39291
39266
|
"websiteUrl": "https://electronjs.org/docs/api/structures/task",
|
|
39292
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39293
|
-
"version": "22.3.
|
|
39267
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/task.md",
|
|
39268
|
+
"version": "22.3.13",
|
|
39294
39269
|
"properties": [
|
|
39295
39270
|
{
|
|
39296
39271
|
"name": "program",
|
|
@@ -39362,8 +39337,8 @@
|
|
|
39362
39337
|
"description": "The `flags` is an array that can include following `string`s:\n\n* `enabled` - The button is active and available to the user.\n* `disabled` - The button is disabled. It is present, but has a visual state indicating it will not respond to user action.\n* `dismissonclick` - When the button is clicked, the thumbnail window closes immediately.\n* `nobackground` - Do not draw a button border, use only the image.\n* `hidden` - The button is not shown to the user.\n* `noninteractive` - The button is enabled but not interactive; no pressed button state is drawn. This value is intended for instances where the button is used in a notification.",
|
|
39363
39338
|
"slug": "thumbar-button",
|
|
39364
39339
|
"websiteUrl": "https://electronjs.org/docs/api/structures/thumbar-button",
|
|
39365
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39366
|
-
"version": "22.3.
|
|
39340
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/thumbar-button.md",
|
|
39341
|
+
"version": "22.3.13",
|
|
39367
39342
|
"properties": [
|
|
39368
39343
|
{
|
|
39369
39344
|
"name": "icon",
|
|
@@ -39409,8 +39384,8 @@
|
|
|
39409
39384
|
"description": "",
|
|
39410
39385
|
"slug": "trace-categories-and-options",
|
|
39411
39386
|
"websiteUrl": "https://electronjs.org/docs/api/structures/trace-categories-and-options",
|
|
39412
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39413
|
-
"version": "22.3.
|
|
39387
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/trace-categories-and-options.md",
|
|
39388
|
+
"version": "22.3.13",
|
|
39414
39389
|
"properties": [
|
|
39415
39390
|
{
|
|
39416
39391
|
"name": "categoryFilter",
|
|
@@ -39438,8 +39413,8 @@
|
|
|
39438
39413
|
"description": "An example TraceConfig that roughly matches what Chrome DevTools records:",
|
|
39439
39414
|
"slug": "trace-config",
|
|
39440
39415
|
"websiteUrl": "https://electronjs.org/docs/api/structures/trace-config",
|
|
39441
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39442
|
-
"version": "22.3.
|
|
39416
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/trace-config.md",
|
|
39417
|
+
"version": "22.3.13",
|
|
39443
39418
|
"properties": [
|
|
39444
39419
|
{
|
|
39445
39420
|
"name": "recording_mode",
|
|
@@ -39553,8 +39528,8 @@
|
|
|
39553
39528
|
"description": "",
|
|
39554
39529
|
"slug": "transaction",
|
|
39555
39530
|
"websiteUrl": "https://electronjs.org/docs/api/structures/transaction",
|
|
39556
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39557
|
-
"version": "22.3.
|
|
39531
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/transaction.md",
|
|
39532
|
+
"version": "22.3.13",
|
|
39558
39533
|
"properties": [
|
|
39559
39534
|
{
|
|
39560
39535
|
"name": "transactionIdentifier",
|
|
@@ -39682,8 +39657,8 @@
|
|
|
39682
39657
|
"description": "",
|
|
39683
39658
|
"slug": "upload-data",
|
|
39684
39659
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-data",
|
|
39685
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39686
|
-
"version": "22.3.
|
|
39660
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/upload-data.md",
|
|
39661
|
+
"version": "22.3.13",
|
|
39687
39662
|
"properties": [
|
|
39688
39663
|
{
|
|
39689
39664
|
"name": "bytes",
|
|
@@ -39719,8 +39694,8 @@
|
|
|
39719
39694
|
"description": "",
|
|
39720
39695
|
"slug": "upload-file",
|
|
39721
39696
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-file",
|
|
39722
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39723
|
-
"version": "22.3.
|
|
39697
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/upload-file.md",
|
|
39698
|
+
"version": "22.3.13",
|
|
39724
39699
|
"properties": [
|
|
39725
39700
|
{
|
|
39726
39701
|
"name": "type",
|
|
@@ -39771,8 +39746,8 @@
|
|
|
39771
39746
|
"description": "",
|
|
39772
39747
|
"slug": "upload-raw-data",
|
|
39773
39748
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-raw-data",
|
|
39774
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39775
|
-
"version": "22.3.
|
|
39749
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/upload-raw-data.md",
|
|
39750
|
+
"version": "22.3.13",
|
|
39776
39751
|
"properties": [
|
|
39777
39752
|
{
|
|
39778
39753
|
"name": "type",
|
|
@@ -39798,8 +39773,8 @@
|
|
|
39798
39773
|
"description": "This type is a helper alias, no object will never exist of this type.",
|
|
39799
39774
|
"slug": "user-default-types",
|
|
39800
39775
|
"websiteUrl": "https://electronjs.org/docs/api/structures/user-default-types",
|
|
39801
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39802
|
-
"version": "22.3.
|
|
39776
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/user-default-types.md",
|
|
39777
|
+
"version": "22.3.13",
|
|
39803
39778
|
"properties": [
|
|
39804
39779
|
{
|
|
39805
39780
|
"name": "string",
|
|
@@ -39892,8 +39867,8 @@
|
|
|
39892
39867
|
"description": "",
|
|
39893
39868
|
"slug": "web-request-filter",
|
|
39894
39869
|
"websiteUrl": "https://electronjs.org/docs/api/structures/web-request-filter",
|
|
39895
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39896
|
-
"version": "22.3.
|
|
39870
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/web-request-filter.md",
|
|
39871
|
+
"version": "22.3.13",
|
|
39897
39872
|
"properties": [
|
|
39898
39873
|
{
|
|
39899
39874
|
"name": "urls",
|
|
@@ -39912,8 +39887,8 @@
|
|
|
39912
39887
|
"description": "",
|
|
39913
39888
|
"slug": "web-source",
|
|
39914
39889
|
"websiteUrl": "https://electronjs.org/docs/api/structures/web-source",
|
|
39915
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39916
|
-
"version": "22.3.
|
|
39890
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.13/docs/api/structures/web-source.md",
|
|
39891
|
+
"version": "22.3.13",
|
|
39917
39892
|
"properties": [
|
|
39918
39893
|
{
|
|
39919
39894
|
"name": "code",
|