@overwolf/ow-electron 31.7.8 → 34.3.0-beta.0

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/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/v31.7.7/docs/api/app.md",
8
- "version": "31.7.7",
7
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/app.md",
8
+ "version": "34.3.0",
9
9
  "type": "Module",
10
10
  "process": {
11
11
  "main": true,
@@ -43,7 +43,7 @@
43
43
  {
44
44
  "name": "relaunch",
45
45
  "signature": "([options])",
46
- "description": "Relaunches the app when current instance exits.\n\nBy default, the new instance will use the same working directory and command line arguments with current instance. When `args` is specified, the `args` will be passed as command line arguments instead. When `execPath` is specified, the `execPath` will be executed for relaunch instead of current app.\n\nNote that this method does not quit the app when executed, you have to call `app.quit` or `app.exit` after calling `app.relaunch` to make the app restart.\n\nWhen `app.relaunch` is called for multiple times, multiple instances will be started after current instance exited.\n\nAn example of restarting current instance immediately and adding a new command line argument to the new instance:",
46
+ "description": "Relaunches the app when the current instance exits.\n\nBy default, the new instance will use the same working directory and command line arguments as the current instance. When `args` is specified, the `args` will be passed as the command line arguments instead. When `execPath` is specified, the `execPath` will be executed for the relaunch instead of the current app.\n\nNote that this method does not quit the app when executed. You have to call `app.quit` or `app.exit` after calling `app.relaunch` to make the app restart.\n\nWhen `app.relaunch` is called multiple times, multiple instances will be started after the current instance exits.\n\nAn example of restarting the current instance immediately and adding a new command line argument to the new instance:",
47
47
  "parameters": [
48
48
  {
49
49
  "name": "options",
@@ -1941,6 +1941,71 @@
1941
1941
  },
1942
1942
  "additionalTags": [],
1943
1943
  "urlFragment": "#appresolveproxyurl"
1944
+ },
1945
+ {
1946
+ "name": "setClientCertRequestPasswordHandler",
1947
+ "signature": "(handler)",
1948
+ "description": "The handler is called when a password is needed to unlock a client certificate for `hostname`.",
1949
+ "parameters": [
1950
+ {
1951
+ "name": "handler",
1952
+ "description": "",
1953
+ "required": true,
1954
+ "collection": false,
1955
+ "type": "Function",
1956
+ "parameters": [
1957
+ {
1958
+ "name": "clientCertRequestParams",
1959
+ "description": "",
1960
+ "required": true,
1961
+ "collection": false,
1962
+ "type": "Object",
1963
+ "properties": [
1964
+ {
1965
+ "name": "hostname",
1966
+ "description": "the hostname of the site requiring a client certificate",
1967
+ "required": true,
1968
+ "additionalTags": [],
1969
+ "collection": false,
1970
+ "type": "String",
1971
+ "possibleValues": null
1972
+ },
1973
+ {
1974
+ "name": "tokenName",
1975
+ "description": "the token (or slot) name of the cryptographic device",
1976
+ "required": true,
1977
+ "additionalTags": [],
1978
+ "collection": false,
1979
+ "type": "String",
1980
+ "possibleValues": null
1981
+ },
1982
+ {
1983
+ "name": "isRetry",
1984
+ "description": "whether there have been previous failed attempts at prompting the password",
1985
+ "required": true,
1986
+ "additionalTags": [],
1987
+ "collection": false,
1988
+ "type": "boolean"
1989
+ }
1990
+ ]
1991
+ }
1992
+ ],
1993
+ "returns": {
1994
+ "collection": false,
1995
+ "type": "Promise",
1996
+ "innerTypes": [
1997
+ {
1998
+ "collection": false,
1999
+ "type": "String",
2000
+ "possibleValues": null
2001
+ }
2002
+ ]
2003
+ }
2004
+ }
2005
+ ],
2006
+ "returns": null,
2007
+ "additionalTags": [],
2008
+ "urlFragment": "#appsetclientcertrequestpasswordhandlerhandler--linux"
1944
2009
  }
1945
2010
  ],
1946
2011
  "properties": [
@@ -2724,7 +2789,7 @@
2724
2789
  },
2725
2790
  {
2726
2791
  "name": "login",
2727
- "description": "Emitted when `webContents` wants to do basic auth.\n\nThe default behavior is to cancel all authentications. To override this you should prevent the default behavior with `event.preventDefault()` and call `callback(username, password)` with the credentials.\n\nIf `callback` is called without a username or password, the authentication request will be cancelled and the authentication error will be returned to the page.",
2792
+ "description": "Emitted when `webContents` or Utility process wants to do basic auth.\n\nThe default behavior is to cancel all authentications. To override this you should prevent the default behavior with `event.preventDefault()` and call `callback(username, password)` with the credentials.\n\nIf `callback` is called without a username or password, the authentication request will be cancelled and the authentication error will be returned to the page.",
2728
2793
  "parameters": [
2729
2794
  {
2730
2795
  "name": "event",
@@ -2755,6 +2820,14 @@
2755
2820
  "additionalTags": [],
2756
2821
  "collection": false,
2757
2822
  "type": "URL"
2823
+ },
2824
+ {
2825
+ "name": "pid",
2826
+ "description": "",
2827
+ "required": true,
2828
+ "additionalTags": [],
2829
+ "collection": false,
2830
+ "type": "number"
2758
2831
  }
2759
2832
  ],
2760
2833
  "additionalTags": [],
@@ -2979,7 +3052,7 @@
2979
3052
  },
2980
3053
  {
2981
3054
  "name": "exitCode",
2982
- "description": "The exit code for the process (e.g. status from waitpid if on posix, from GetExitCodeProcess on Windows).",
3055
+ "description": "The exit code for the process (e.g. status from waitpid if on POSIX, from GetExitCodeProcess on Windows).",
2983
3056
  "required": true,
2984
3057
  "additionalTags": [],
2985
3058
  "collection": false,
@@ -3101,11 +3174,11 @@
3101
3174
  },
3102
3175
  {
3103
3176
  "name": "autoUpdater",
3104
- "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.",
3177
+ "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 electron-winstaller or Electron Forge's Squirrel.Windows maker to generate a Windows installer.\n\nApps built with Squirrel.Windows will trigger custom launch events that must be handled by your Electron application to ensure proper setup and teardown.\n\nSquirrel.Windows apps will launch with the `--squirrel-firstrun` argument immediately after installation. During this time, Squirrel.Windows will obtain a file lock on your app, and `autoUpdater` requests will fail until the lock is released. In practice, this means that you won't be able to check for updates on first launch for the first few seconds. You can work around this by not checking for updates when `process.argv` contains the `--squirrel-firstrun` flag or by setting a 10-second timeout on your update checks (see electron/electron#7155 for more information).\n\nThe installer generated with Squirrel.Windows 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.",
3105
3178
  "slug": "auto-updater",
3106
3179
  "websiteUrl": "https://electronjs.org/docs/api/auto-updater",
3107
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/auto-updater.md",
3108
- "version": "31.7.7",
3180
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/auto-updater.md",
3181
+ "version": "34.3.0",
3109
3182
  "type": "Module",
3110
3183
  "process": {
3111
3184
  "main": true,
@@ -3318,11 +3391,11 @@
3318
3391
  },
3319
3392
  {
3320
3393
  "name": "BaseWindow",
3321
- "description": "> Create and control windows.\n\nProcess: Main\n\n> **Note** `BaseWindow` provides a flexible way to compose multiple web views in a single window. For windows with only a single, full-size web view, the `BrowserWindow` class may be a simpler option.\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Parent and child windows\n\nBy using `parent` option, you can create child windows:\n\n```\nconst { BaseWindow } = require('electron')\n\nconst parent = new BaseWindow()\nconst child = new BaseWindow({ parent })\n```\n\nThe `child` window will always show on top of the `parent` 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 the `parent` and `modal` options:\n\n```\nconst { BaseWindow } = require('electron')\n\nconst parent = new BaseWindow()\nconst child = new BaseWindow({ parent, modal: true })\n```\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: BaseWindow\n\n> Create and control windows.\n\nProcess: Main\n\n`BaseWindow` is an EventEmitter.\n\nIt creates a new `BaseWindow` with native properties as set by the `options`.",
3394
+ "description": "> Create and control windows.\n\nProcess: Main\n\n> **Note** `BaseWindow` provides a flexible way to compose multiple web views in a single window. For windows with only a single, full-size web view, the `BrowserWindow` class may be a simpler option.\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Parent and child windows\n\nBy using `parent` option, you can create child windows:\n\n```\nconst { BaseWindow } = require('electron')\n\nconst parent = new BaseWindow()\nconst child = new BaseWindow({ parent })\n```\n\nThe `child` window will always show on top of the `parent` 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 the `parent` and `modal` options:\n\n```\nconst { BaseWindow } = require('electron')\n\nconst parent = new BaseWindow()\nconst child = new BaseWindow({ parent, modal: true })\n```\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### Resource management\n\nWhen you add a `WebContentsView` to a `BaseWindow` and the `BaseWindow` is closed, the `webContents` of the `WebContentsView` are not destroyed automatically.\n\nIt is your responsibility to close the `webContents` when you no longer need them, e.g. when the `BaseWindow` is closed:\n\n```\nconst { BaseWindow, WebContentsView } = require('electron')\n\nconst win = new BaseWindow({ width: 800, height: 600 })\n\nconst view = new WebContentsView()\nwin.contentView.addChildView(view)\n\nwin.on('closed', () => {\n view.webContents.close()\n})\n```\n\nUnlike with a `BrowserWindow`, if you don't explicitly close the `webContents`, you'll encounter memory leaks.\n\n### Class: BaseWindow\n\n> Create and control windows.\n\nProcess: Main\n\n`BaseWindow` is an EventEmitter.\n\nIt creates a new `BaseWindow` with native properties as set by the `options`.",
3322
3395
  "slug": "base-window",
3323
3396
  "websiteUrl": "https://electronjs.org/docs/api/base-window",
3324
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/base-window.md",
3325
- "version": "31.7.7",
3397
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/base-window.md",
3398
+ "version": "34.3.0",
3326
3399
  "type": "Class",
3327
3400
  "process": {
3328
3401
  "main": true,
@@ -6472,8 +6545,8 @@
6472
6545
  "description": "> **Note** The `BrowserView` class is deprecated, and replaced by the new `WebContentsView` class.\n\nA `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\n> **Note** The `BrowserView` class is deprecated, and replaced by the new `WebContentsView` class.\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```",
6473
6546
  "slug": "browser-view",
6474
6547
  "websiteUrl": "https://electronjs.org/docs/api/browser-view",
6475
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/browser-view.md",
6476
- "version": "31.7.7",
6548
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/browser-view.md",
6549
+ "version": "34.3.0",
6477
6550
  "type": "Class",
6478
6551
  "process": {
6479
6552
  "main": true,
@@ -6640,8 +6713,8 @@
6640
6713
  "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 the `parent` and `modal` options:\n\n```\nconst { BrowserWindow } = require('electron')\n\nconst top = new BrowserWindow()\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 extends `BaseWindow`\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`.",
6641
6714
  "slug": "browser-window",
6642
6715
  "websiteUrl": "https://electronjs.org/docs/api/browser-window",
6643
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/browser-window.md",
6644
- "version": "31.7.7",
6716
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/browser-window.md",
6717
+ "version": "34.3.0",
6645
6718
  "type": "Class",
6646
6719
  "process": {
6647
6720
  "main": true,
@@ -10266,8 +10339,8 @@
10266
10339
  "description": "> Make HTTP/HTTPS requests.\n\nProcess: Main, Utility\n _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.",
10267
10340
  "slug": "client-request",
10268
10341
  "websiteUrl": "https://electronjs.org/docs/api/client-request",
10269
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/client-request.md",
10270
- "version": "31.7.7",
10342
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/client-request.md",
10343
+ "version": "34.3.0",
10271
10344
  "type": "Class",
10272
10345
  "process": {
10273
10346
  "main": true,
@@ -10998,8 +11071,8 @@
10998
11071
  "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:",
10999
11072
  "slug": "clipboard",
11000
11073
  "websiteUrl": "https://electronjs.org/docs/api/clipboard",
11001
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/clipboard.md",
11002
- "version": "31.7.7",
11074
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/clipboard.md",
11075
+ "version": "34.3.0",
11003
11076
  "type": "Module",
11004
11077
  "process": {
11005
11078
  "main": true,
@@ -11665,8 +11738,8 @@
11665
11738
  "description": "",
11666
11739
  "slug": "command-line",
11667
11740
  "websiteUrl": "https://electronjs.org/docs/api/command-line",
11668
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/command-line.md",
11669
- "version": "31.7.7",
11741
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/command-line.md",
11742
+ "version": "34.3.0",
11670
11743
  "type": "Class",
11671
11744
  "process": {
11672
11745
  "main": true,
@@ -11793,8 +11866,8 @@
11793
11866
  "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.",
11794
11867
  "slug": "content-tracing",
11795
11868
  "websiteUrl": "https://electronjs.org/docs/api/content-tracing",
11796
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/content-tracing.md",
11797
- "version": "31.7.7",
11869
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/content-tracing.md",
11870
+ "version": "34.3.0",
11798
11871
  "type": "Module",
11799
11872
  "process": {
11800
11873
  "main": true,
@@ -11931,8 +12004,8 @@
11931
12004
  "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.",
11932
12005
  "slug": "context-bridge",
11933
12006
  "websiteUrl": "https://electronjs.org/docs/api/context-bridge",
11934
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/context-bridge.md",
11935
- "version": "31.7.7",
12007
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/context-bridge.md",
12008
+ "version": "34.3.0",
11936
12009
  "type": "Module",
11937
12010
  "process": {
11938
12011
  "main": false,
@@ -12008,8 +12081,8 @@
12008
12081
  "description": "",
12009
12082
  "slug": "cookies",
12010
12083
  "websiteUrl": "https://electronjs.org/docs/api/cookies",
12011
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/cookies.md",
12012
- "version": "31.7.7",
12084
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/cookies.md",
12085
+ "version": "34.3.0",
12013
12086
  "type": "Class",
12014
12087
  "process": {
12015
12088
  "main": true,
@@ -12358,8 +12431,8 @@
12358
12431
  "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.",
12359
12432
  "slug": "crash-reporter",
12360
12433
  "websiteUrl": "https://electronjs.org/docs/api/crash-reporter",
12361
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/crash-reporter.md",
12362
- "version": "31.7.7",
12434
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/crash-reporter.md",
12435
+ "version": "34.3.0",
12363
12436
  "type": "Module",
12364
12437
  "process": {
12365
12438
  "main": true,
@@ -12631,8 +12704,8 @@
12631
12704
  "description": "",
12632
12705
  "slug": "debugger",
12633
12706
  "websiteUrl": "https://electronjs.org/docs/api/debugger",
12634
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/debugger.md",
12635
- "version": "31.7.7",
12707
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/debugger.md",
12708
+ "version": "34.3.0",
12636
12709
  "type": "Class",
12637
12710
  "process": {
12638
12711
  "main": true,
@@ -12800,11 +12873,11 @@
12800
12873
  },
12801
12874
  {
12802
12875
  "name": "desktopCapturer",
12803
- "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// main.js\nconst { app, BrowserWindow, desktopCapturer, session } = require('electron')\n\napp.whenReady().then(() => {\n const mainWindow = new BrowserWindow()\n\n session.defaultSession.setDisplayMediaRequestHandler((request, callback) => {\n desktopCapturer.getSources({ types: ['screen'] }).then((sources) => {\n // Grant access to the first screen found.\n callback({ video: sources[0], audio: 'loopback' })\n })\n })\n\n mainWindow.loadFile('index.html')\n})\n```\n\n```\n// renderer.js\nconst startButton = document.getElementById('startButton')\nconst stopButton = document.getElementById('stopButton')\nconst video = document.querySelector('video')\n\nstartButton.addEventListener('click', () => {\n navigator.mediaDevices.getDisplayMedia({\n audio: true,\n video: {\n width: 320,\n height: 240,\n frameRate: 30\n }\n }).then(stream => {\n video.srcObject = stream\n video.onloadedmetadata = (e) => video.play()\n }).catch(e => console.log(e))\n})\n\nstopButton.addEventListener('click', () => {\n video.pause()\n})\n```\n\n```\n<!-- index.html -->\n<html>\n<meta http-equiv=\"content-security-policy\" content=\"script-src 'self' 'unsafe-inline'\" />\n <body>\n <button id=\"startButton\" class=\"button\">Start</button>\n <button id=\"stopButton\" class=\"button\">Stop</button>\n <video width=\"320\" height=\"240\" autoplay></video>\n <script src=\"renderer.js\"></script>\n </body>\n</html>\n```\n\nSee `navigator.mediaDevices.getDisplayMedia` for more information.\n\n**Note:** `navigator.mediaDevices.getDisplayMedia` does not permit the use of `deviceId` for selection of a source - see specification.",
12876
+ "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// main.js\nconst { app, BrowserWindow, desktopCapturer, session } = require('electron')\n\napp.whenReady().then(() => {\n const mainWindow = new BrowserWindow()\n\n session.defaultSession.setDisplayMediaRequestHandler((request, callback) => {\n desktopCapturer.getSources({ types: ['screen'] }).then((sources) => {\n // Grant access to the first screen found.\n callback({ video: sources[0], audio: 'loopback' })\n })\n // If true, use the system picker if available.\n // Note: this is currently experimental. If the system picker\n // is available, it will be used and the media request handler\n // will not be invoked.\n }, { useSystemPicker: true })\n\n mainWindow.loadFile('index.html')\n})\n```\n\n```\n// renderer.js\nconst startButton = document.getElementById('startButton')\nconst stopButton = document.getElementById('stopButton')\nconst video = document.querySelector('video')\n\nstartButton.addEventListener('click', () => {\n navigator.mediaDevices.getDisplayMedia({\n audio: true,\n video: {\n width: 320,\n height: 240,\n frameRate: 30\n }\n }).then(stream => {\n video.srcObject = stream\n video.onloadedmetadata = (e) => video.play()\n }).catch(e => console.log(e))\n})\n\nstopButton.addEventListener('click', () => {\n video.pause()\n})\n```\n\n```\n<!-- index.html -->\n<html>\n<meta http-equiv=\"content-security-policy\" content=\"script-src 'self' 'unsafe-inline'\" />\n <body>\n <button id=\"startButton\" class=\"button\">Start</button>\n <button id=\"stopButton\" class=\"button\">Stop</button>\n <video width=\"320\" height=\"240\" autoplay></video>\n <script src=\"renderer.js\"></script>\n </body>\n</html>\n```\n\nSee `navigator.mediaDevices.getDisplayMedia` for more information.\n\n**Note:** `navigator.mediaDevices.getDisplayMedia` does not permit the use of `deviceId` for selection of a source - see specification.",
12804
12877
  "slug": "desktop-capturer",
12805
12878
  "websiteUrl": "https://electronjs.org/docs/api/desktop-capturer",
12806
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/desktop-capturer.md",
12807
- "version": "31.7.7",
12879
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/desktop-capturer.md",
12880
+ "version": "34.3.0",
12808
12881
  "type": "Module",
12809
12882
  "process": {
12810
12883
  "main": true,
@@ -12885,8 +12958,8 @@
12885
12958
  "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:",
12886
12959
  "slug": "dialog",
12887
12960
  "websiteUrl": "https://electronjs.org/docs/api/dialog",
12888
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/dialog.md",
12889
- "version": "31.7.7",
12961
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/dialog.md",
12962
+ "version": "34.3.0",
12890
12963
  "type": "Module",
12891
12964
  "process": {
12892
12965
  "main": true,
@@ -12897,15 +12970,15 @@
12897
12970
  "methods": [
12898
12971
  {
12899
12972
  "name": "showOpenDialogSync",
12900
- "signature": "([browserWindow, ]options)",
12901
- "description": "the file paths chosen by the user; if the dialog is cancelled it returns `undefined`.\n\nThe `browserWindow` argument allows the dialog to attach itself to a parent window, making it modal.\n\nThe `filters` specifies an array of file types that can be displayed or selected when you want to limit the user to a specific type. For example:\n\nThe `extensions` array should contain extensions without wildcards or dots (e.g. `'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the `'*'` wildcard (no other wildcard is supported).\n\n**Note:** On Windows and Linux an open dialog can not be both a file selector and a directory selector, so if you set `properties` to `['openFile', 'openDirectory']` on these platforms, a directory selector will be shown.",
12973
+ "signature": "([window, ]options)",
12974
+ "description": "the file paths chosen by the user; if the dialog is cancelled it returns `undefined`.\n\nThe `window` argument allows the dialog to attach itself to a parent window, making it modal.\n\nThe `filters` specifies an array of file types that can be displayed or selected when you want to limit the user to a specific type. For example:\n\nThe `extensions` array should contain extensions without wildcards or dots (e.g. `'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the `'*'` wildcard (no other wildcard is supported).\n\n**Note:** On Windows and Linux an open dialog can not be both a file selector and a directory selector, so if you set `properties` to `['openFile', 'openDirectory']` on these platforms, a directory selector will be shown.\n\n**Note:** On Linux `defaultPath` is not supported when using portal file chooser dialogs unless the portal backend is version 4 or higher. You can use `--xdg-portal-required-version` command-line switch to force gtk or kde dialogs.",
12902
12975
  "parameters": [
12903
12976
  {
12904
- "name": "browserWindow",
12977
+ "name": "window",
12905
12978
  "description": "",
12906
12979
  "required": false,
12907
12980
  "collection": false,
12908
- "type": "BrowserWindow"
12981
+ "type": "BaseWindow"
12909
12982
  },
12910
12983
  {
12911
12984
  "name": "options",
@@ -13035,19 +13108,19 @@
13035
13108
  ]
13036
13109
  },
13037
13110
  "additionalTags": [],
13038
- "urlFragment": "#dialogshowopendialogsyncbrowserwindow-options"
13111
+ "urlFragment": "#dialogshowopendialogsyncwindow-options"
13039
13112
  },
13040
13113
  {
13041
13114
  "name": "showOpenDialog",
13042
- "signature": "([browserWindow, ]options)",
13043
- "description": "Resolve with an object containing the following:\n\n* `canceled` boolean - whether or not the dialog was canceled.\n* `filePaths` string[] - An array of file paths chosen by the user. If the dialog is cancelled this will be an empty array.\n* `bookmarks` string[] (optional) _macOS_ _mas_ - An array matching the `filePaths` array of base64 encoded strings which contains security scoped bookmark data. `securityScopedBookmarks` must be enabled for this to be populated. (For return values, see table here.)\n\nThe `browserWindow` argument allows the dialog to attach itself to a parent window, making it modal.\n\nThe `filters` specifies an array of file types that can be displayed or selected when you want to limit the user to a specific type. For example:\n\nThe `extensions` array should contain extensions without wildcards or dots (e.g. `'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the `'*'` wildcard (no other wildcard is supported).\n\n**Note:** On Windows and Linux an open dialog can not be both a file selector and a directory selector, so if you set `properties` to `['openFile', 'openDirectory']` on these platforms, a directory selector will be shown.",
13115
+ "signature": "([window, ]options)",
13116
+ "description": "Resolve with an object containing the following:\n\n* `canceled` boolean - whether or not the dialog was canceled.\n* `filePaths` string[] - An array of file paths chosen by the user. If the dialog is cancelled this will be an empty array.\n* `bookmarks` string[] (optional) _macOS_ _mas_ - An array matching the `filePaths` array of base64 encoded strings which contains security scoped bookmark data. `securityScopedBookmarks` must be enabled for this to be populated. (For return values, see table here.)\n\nThe `window` argument allows the dialog to attach itself to a parent window, making it modal.\n\nThe `filters` specifies an array of file types that can be displayed or selected when you want to limit the user to a specific type. For example:\n\nThe `extensions` array should contain extensions without wildcards or dots (e.g. `'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the `'*'` wildcard (no other wildcard is supported).\n\n**Note:** On Windows and Linux an open dialog can not be both a file selector and a directory selector, so if you set `properties` to `['openFile', 'openDirectory']` on these platforms, a directory selector will be shown.\n\n**Note:** On Linux `defaultPath` is not supported when using portal file chooser dialogs unless the portal backend is version 4 or higher. You can use `--xdg-portal-required-version` command-line switch to force gtk or kde dialogs.",
13044
13117
  "parameters": [
13045
13118
  {
13046
- "name": "browserWindow",
13119
+ "name": "window",
13047
13120
  "description": "",
13048
13121
  "required": false,
13049
13122
  "collection": false,
13050
- "type": "BrowserWindow"
13123
+ "type": "BaseWindow"
13051
13124
  },
13052
13125
  {
13053
13126
  "name": "options",
@@ -13204,19 +13277,19 @@
13204
13277
  ]
13205
13278
  },
13206
13279
  "additionalTags": [],
13207
- "urlFragment": "#dialogshowopendialogbrowserwindow-options"
13280
+ "urlFragment": "#dialogshowopendialogwindow-options"
13208
13281
  },
13209
13282
  {
13210
13283
  "name": "showSaveDialogSync",
13211
- "signature": "([browserWindow, ]options)",
13212
- "description": "the path of the file chosen by the user; if the dialog is cancelled it returns an empty string.\n\nThe `browserWindow` argument allows the dialog to attach itself to a parent window, making it modal.\n\nThe `filters` specifies an array of file types that can be displayed, see `dialog.showOpenDialog` for an example.",
13284
+ "signature": "([window, ]options)",
13285
+ "description": "the path of the file chosen by the user; if the dialog is cancelled it returns an empty string.\n\nThe `window` argument allows the dialog to attach itself to a parent window, making it modal.\n\nThe `filters` specifies an array of file types that can be displayed, see `dialog.showOpenDialog` for an example.",
13213
13286
  "parameters": [
13214
13287
  {
13215
- "name": "browserWindow",
13288
+ "name": "window",
13216
13289
  "description": "",
13217
13290
  "required": false,
13218
13291
  "collection": false,
13219
- "type": "BrowserWindow"
13292
+ "type": "BaseWindow"
13220
13293
  },
13221
13294
  {
13222
13295
  "name": "options",
@@ -13342,19 +13415,19 @@
13342
13415
  "possibleValues": null
13343
13416
  },
13344
13417
  "additionalTags": [],
13345
- "urlFragment": "#dialogshowsavedialogsyncbrowserwindow-options"
13418
+ "urlFragment": "#dialogshowsavedialogsyncwindow-options"
13346
13419
  },
13347
13420
  {
13348
13421
  "name": "showSaveDialog",
13349
- "signature": "([browserWindow, ]options)",
13350
- "description": "Resolve with an object containing the following:\n\n* `canceled` boolean - whether or not the dialog was canceled.\n* `filePath` string - If the dialog is canceled, this will be an empty string.\n* `bookmark` string (optional) _macOS_ _mas_ - Base64 encoded string which contains the security scoped bookmark data for the saved file. `securityScopedBookmarks` must be enabled for this to be present. (For return values, see table here.)\n\nThe `browserWindow` argument allows the dialog to attach itself to a parent window, making it modal.\n\nThe `filters` specifies an array of file types that can be displayed, see `dialog.showOpenDialog` for an example.\n\n**Note:** On macOS, using the asynchronous version is recommended to avoid issues when expanding and collapsing the dialog.",
13422
+ "signature": "([window, ]options)",
13423
+ "description": "Resolve with an object containing the following:\n\n* `canceled` boolean - whether or not the dialog was canceled.\n* `filePath` string - If the dialog is canceled, this will be an empty string.\n* `bookmark` string (optional) _macOS_ _mas_ - Base64 encoded string which contains the security scoped bookmark data for the saved file. `securityScopedBookmarks` must be enabled for this to be present. (For return values, see table here.)\n\nThe `window` argument allows the dialog to attach itself to a parent window, making it modal.\n\nThe `filters` specifies an array of file types that can be displayed, see `dialog.showOpenDialog` for an example.\n\n**Note:** On macOS, using the asynchronous version is recommended to avoid issues when expanding and collapsing the dialog.",
13351
13424
  "parameters": [
13352
13425
  {
13353
- "name": "browserWindow",
13426
+ "name": "window",
13354
13427
  "description": "",
13355
13428
  "required": false,
13356
13429
  "collection": false,
13357
- "type": "BrowserWindow"
13430
+ "type": "BaseWindow"
13358
13431
  },
13359
13432
  {
13360
13433
  "name": "options",
@@ -13516,19 +13589,19 @@
13516
13589
  ]
13517
13590
  },
13518
13591
  "additionalTags": [],
13519
- "urlFragment": "#dialogshowsavedialogbrowserwindow-options"
13592
+ "urlFragment": "#dialogshowsavedialogwindow-options"
13520
13593
  },
13521
13594
  {
13522
13595
  "name": "showMessageBoxSync",
13523
- "signature": "([browserWindow, ]options)",
13524
- "description": "the index of the clicked button.\n\nShows a message box, it will block the process until the message box is closed. It returns the index of the clicked button.\n\nThe `browserWindow` argument allows the dialog to attach itself to a parent window, making it modal. If `browserWindow` is not shown dialog will not be attached to it. In such case it will be displayed as an independent window.",
13596
+ "signature": "([wndow, ]options)",
13597
+ "description": "the index of the clicked button.\n\nShows a message box, it will block the process until the message box is closed. It returns the index of the clicked button.\n\nThe `window` argument allows the dialog to attach itself to a parent window, making it modal. If `window` is not shown dialog will not be attached to it. In such case it will be displayed as an independent window.",
13525
13598
  "parameters": [
13526
13599
  {
13527
- "name": "browserWindow",
13600
+ "name": "window",
13528
13601
  "description": "",
13529
13602
  "required": false,
13530
13603
  "collection": false,
13531
- "type": "BrowserWindow"
13604
+ "type": "BaseWindow"
13532
13605
  },
13533
13606
  {
13534
13607
  "name": "options",
@@ -13671,19 +13744,19 @@
13671
13744
  "type": "Integer"
13672
13745
  },
13673
13746
  "additionalTags": [],
13674
- "urlFragment": "#dialogshowmessageboxsyncbrowserwindow-options"
13747
+ "urlFragment": "#dialogshowmessageboxsyncwndow-options"
13675
13748
  },
13676
13749
  {
13677
13750
  "name": "showMessageBox",
13678
- "signature": "([browserWindow, ]options)",
13679
- "description": "resolves with a promise containing the following properties:\n\n* `response` number - The index of the clicked button.\n* `checkboxChecked` boolean - The checked state of the checkbox if `checkboxLabel` was set. Otherwise `false`.\n\nShows a message box.\n\nThe `browserWindow` argument allows the dialog to attach itself to a parent window, making it modal.",
13751
+ "signature": "([window, ]options)",
13752
+ "description": "resolves with a promise containing the following properties:\n\n* `response` number - The index of the clicked button.\n* `checkboxChecked` boolean - The checked state of the checkbox if `checkboxLabel` was set. Otherwise `false`.\n\nShows a message box.\n\nThe `window` argument allows the dialog to attach itself to a parent window, making it modal.",
13680
13753
  "parameters": [
13681
13754
  {
13682
- "name": "browserWindow",
13755
+ "name": "window",
13683
13756
  "description": "",
13684
13757
  "required": false,
13685
13758
  "collection": false,
13686
- "type": "BrowserWindow"
13759
+ "type": "BaseWindow"
13687
13760
  },
13688
13761
  {
13689
13762
  "name": "options",
@@ -13875,7 +13948,7 @@
13875
13948
  ]
13876
13949
  },
13877
13950
  "additionalTags": [],
13878
- "urlFragment": "#dialogshowmessageboxbrowserwindow-options"
13951
+ "urlFragment": "#dialogshowmessageboxwindow-options"
13879
13952
  },
13880
13953
  {
13881
13954
  "name": "showErrorBox",
@@ -13905,15 +13978,15 @@
13905
13978
  },
13906
13979
  {
13907
13980
  "name": "showCertificateTrustDialog",
13908
- "signature": "([browserWindow, ]options)",
13909
- "description": "resolves when the certificate trust dialog is shown.\n\nOn macOS, this displays a modal dialog that shows a message and certificate information, and gives the user the option of trusting/importing the certificate. If you provide a `browserWindow` argument the dialog will be attached to the parent window, making it modal.\n\nOn Windows the options are more limited, due to the Win32 APIs used:\n\n* The `message` argument is not used, as the OS provides its own confirmation dialog.\n* The `browserWindow` argument is ignored since it is not possible to make this confirmation dialog modal.",
13981
+ "signature": "([window, ]options)",
13982
+ "description": "resolves when the certificate trust dialog is shown.\n\nOn macOS, this displays a modal dialog that shows a message and certificate information, and gives the user the option of trusting/importing the certificate. If you provide a `window` argument the dialog will be attached to the parent window, making it modal.\n\nOn Windows the options are more limited, due to the Win32 APIs used:\n\n* The `message` argument is not used, as the OS provides its own confirmation dialog.\n* The `window` argument is ignored since it is not possible to make this confirmation dialog modal.",
13910
13983
  "parameters": [
13911
13984
  {
13912
- "name": "browserWindow",
13985
+ "name": "window",
13913
13986
  "description": "",
13914
13987
  "required": false,
13915
13988
  "collection": false,
13916
- "type": "BrowserWindow"
13989
+ "type": "BaseWindow"
13917
13990
  },
13918
13991
  {
13919
13992
  "name": "options",
@@ -13956,7 +14029,7 @@
13956
14029
  "os_macos",
13957
14030
  "os_windows"
13958
14031
  ],
13959
- "urlFragment": "#dialogshowcertificatetrustdialogbrowserwindow-options-macos-windows"
14032
+ "urlFragment": "#dialogshowcertificatetrustdialogwindow-options-macos-windows"
13960
14033
  }
13961
14034
  ],
13962
14035
  "properties": [],
@@ -13968,8 +14041,8 @@
13968
14041
  "description": "",
13969
14042
  "slug": "dock",
13970
14043
  "websiteUrl": "https://electronjs.org/docs/api/dock",
13971
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/dock.md",
13972
- "version": "31.7.7",
14044
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/dock.md",
14045
+ "version": "34.3.0",
13973
14046
  "type": "Class",
13974
14047
  "process": {
13975
14048
  "main": true,
@@ -14213,8 +14286,8 @@
14213
14286
  "description": "",
14214
14287
  "slug": "download-item",
14215
14288
  "websiteUrl": "https://electronjs.org/docs/api/download-item",
14216
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/download-item.md",
14217
- "version": "31.7.7",
14289
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/download-item.md",
14290
+ "version": "34.3.0",
14218
14291
  "type": "Class",
14219
14292
  "process": {
14220
14293
  "main": true,
@@ -14636,8 +14709,8 @@
14636
14709
  "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.",
14637
14710
  "slug": "global-shortcut",
14638
14711
  "websiteUrl": "https://electronjs.org/docs/api/global-shortcut",
14639
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/global-shortcut.md",
14640
- "version": "31.7.7",
14712
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/global-shortcut.md",
14713
+ "version": "34.3.0",
14641
14714
  "type": "Module",
14642
14715
  "process": {
14643
14716
  "main": true,
@@ -14757,8 +14830,8 @@
14757
14830
  "description": "> In-app purchases on Mac App Store.\n\nProcess: Main",
14758
14831
  "slug": "in-app-purchase",
14759
14832
  "websiteUrl": "https://electronjs.org/docs/api/in-app-purchase",
14760
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/in-app-purchase.md",
14761
- "version": "31.7.7",
14833
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/in-app-purchase.md",
14834
+ "version": "34.3.0",
14762
14835
  "type": "Module",
14763
14836
  "process": {
14764
14837
  "main": true,
@@ -14935,8 +15008,8 @@
14935
15008
  "description": "",
14936
15009
  "slug": "incoming-message",
14937
15010
  "websiteUrl": "https://electronjs.org/docs/api/incoming-message",
14938
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/incoming-message.md",
14939
- "version": "31.7.7",
15011
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/incoming-message.md",
15012
+ "version": "34.3.0",
14940
15013
  "type": "Class",
14941
15014
  "process": {
14942
15015
  "main": true,
@@ -15093,8 +15166,8 @@
15093
15166
  "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.",
15094
15167
  "slug": "ipc-main",
15095
15168
  "websiteUrl": "https://electronjs.org/docs/api/ipc-main",
15096
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/ipc-main.md",
15097
- "version": "31.7.7",
15169
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/ipc-main.md",
15170
+ "version": "34.3.0",
15098
15171
  "type": "Module",
15099
15172
  "process": {
15100
15173
  "main": true,
@@ -15146,9 +15219,9 @@
15146
15219
  "urlFragment": "#ipcmainonchannel-listener"
15147
15220
  },
15148
15221
  {
15149
- "name": "once",
15222
+ "name": "off",
15150
15223
  "signature": "(channel, listener)",
15151
- "description": "Adds a one time `listener` function for the event. This `listener` is invoked only the next time a message is sent to `channel`, after which it is removed.",
15224
+ "description": "Removes the specified `listener` from the listener array for the specified `channel`.",
15152
15225
  "parameters": [
15153
15226
  {
15154
15227
  "name": "channel",
@@ -15185,12 +15258,12 @@
15185
15258
  ],
15186
15259
  "returns": null,
15187
15260
  "additionalTags": [],
15188
- "urlFragment": "#ipcmainoncechannel-listener"
15261
+ "urlFragment": "#ipcmainoffchannel-listener"
15189
15262
  },
15190
15263
  {
15191
- "name": "removeListener",
15264
+ "name": "once",
15192
15265
  "signature": "(channel, listener)",
15193
- "description": "Removes the specified `listener` from the listener array for the specified `channel`.",
15266
+ "description": "Adds a one time `listener` function for the event. This `listener` is invoked only the next time a message is sent to `channel`, after which it is removed.",
15194
15267
  "parameters": [
15195
15268
  {
15196
15269
  "name": "channel",
@@ -15207,6 +15280,13 @@
15207
15280
  "collection": false,
15208
15281
  "type": "Function",
15209
15282
  "parameters": [
15283
+ {
15284
+ "name": "event",
15285
+ "description": "",
15286
+ "required": true,
15287
+ "collection": false,
15288
+ "type": "IpcMainEvent"
15289
+ },
15210
15290
  {
15211
15291
  "name": "...args",
15212
15292
  "description": "",
@@ -15220,30 +15300,12 @@
15220
15300
  ],
15221
15301
  "returns": null,
15222
15302
  "additionalTags": [],
15223
- "urlFragment": "#ipcmainremovelistenerchannel-listener"
15224
- },
15225
- {
15226
- "name": "removeAllListeners",
15227
- "signature": "([channel])",
15228
- "description": "Removes listeners of the specified `channel`.",
15229
- "parameters": [
15230
- {
15231
- "name": "channel",
15232
- "description": "",
15233
- "required": false,
15234
- "collection": false,
15235
- "type": "String",
15236
- "possibleValues": null
15237
- }
15238
- ],
15239
- "returns": null,
15240
- "additionalTags": [],
15241
- "urlFragment": "#ipcmainremovealllistenerschannel"
15303
+ "urlFragment": "#ipcmainoncechannel-listener"
15242
15304
  },
15243
15305
  {
15244
- "name": "handle",
15306
+ "name": "addListener",
15245
15307
  "signature": "(channel, listener)",
15246
- "description": "Adds a handler for an `invoke`able IPC. This handler will be called whenever a renderer calls `ipcRenderer.invoke(channel, ...args)`.\n\nIf `listener` returns a Promise, the eventual result of the promise will be returned as a reply to the remote caller. Otherwise, the return value of the listener will be used as the value of the reply.\n\nThe `event` that is passed as the first argument to the handler is the same as that passed to a regular event listener. It includes information about which WebContents is the source of the invoke request.\n\nErrors thrown through `handle` in the main process are not transparent as they are serialized and only the `message` property from the original error is provided to the renderer process. Please refer to #24427 for details.",
15308
+ "description": "Alias for `ipcMain.on`.",
15247
15309
  "parameters": [
15248
15310
  {
15249
15311
  "name": "channel",
@@ -15265,7 +15327,7 @@
15265
15327
  "description": "",
15266
15328
  "required": true,
15267
15329
  "collection": false,
15268
- "type": "IpcMainInvokeEvent"
15330
+ "type": "IpcMainEvent"
15269
15331
  },
15270
15332
  {
15271
15333
  "name": "...args",
@@ -15275,35 +15337,17 @@
15275
15337
  "type": "any"
15276
15338
  }
15277
15339
  ],
15278
- "returns": {
15279
- "collection": false,
15280
- "type": [
15281
- {
15282
- "collection": false,
15283
- "type": "Promise",
15284
- "innerTypes": [
15285
- {
15286
- "collection": false,
15287
- "type": "any"
15288
- }
15289
- ]
15290
- },
15291
- {
15292
- "collection": false,
15293
- "type": "any"
15294
- }
15295
- ]
15296
- }
15340
+ "returns": null
15297
15341
  }
15298
15342
  ],
15299
15343
  "returns": null,
15300
15344
  "additionalTags": [],
15301
- "urlFragment": "#ipcmainhandlechannel-listener"
15345
+ "urlFragment": "#ipcmainaddlistenerchannel-listener"
15302
15346
  },
15303
15347
  {
15304
- "name": "handleOnce",
15348
+ "name": "removeListener",
15305
15349
  "signature": "(channel, listener)",
15306
- "description": "Handles a single `invoke`able IPC message, then removes the listener. See `ipcMain.handle(channel, listener)`.",
15350
+ "description": "Alias for `ipcMain.off`.",
15307
15351
  "parameters": [
15308
15352
  {
15309
15353
  "name": "channel",
@@ -15320,13 +15364,6 @@
15320
15364
  "collection": false,
15321
15365
  "type": "Function",
15322
15366
  "parameters": [
15323
- {
15324
- "name": "event",
15325
- "description": "",
15326
- "required": true,
15327
- "collection": false,
15328
- "type": "IpcMainInvokeEvent"
15329
- },
15330
15367
  {
15331
15368
  "name": "...args",
15332
15369
  "description": "",
@@ -15335,115 +15372,35 @@
15335
15372
  "type": "any"
15336
15373
  }
15337
15374
  ],
15338
- "returns": {
15339
- "collection": false,
15340
- "type": [
15341
- {
15342
- "collection": false,
15343
- "type": "Promise",
15344
- "innerTypes": [
15345
- {
15346
- "collection": false,
15347
- "type": "any"
15348
- }
15349
- ]
15350
- },
15351
- {
15352
- "collection": false,
15353
- "type": "any"
15354
- }
15355
- ]
15356
- }
15375
+ "returns": null
15357
15376
  }
15358
15377
  ],
15359
15378
  "returns": null,
15360
15379
  "additionalTags": [],
15361
- "urlFragment": "#ipcmainhandleoncechannel-listener"
15380
+ "urlFragment": "#ipcmainremovelistenerchannel-listener"
15362
15381
  },
15363
15382
  {
15364
- "name": "removeHandler",
15365
- "signature": "(channel)",
15366
- "description": "Removes any handler for `channel`, if present.",
15367
- "parameters": [
15368
- {
15369
- "name": "channel",
15370
- "description": "",
15371
- "required": true,
15372
- "collection": false,
15373
- "type": "String",
15374
- "possibleValues": null
15375
- }
15376
- ],
15377
- "returns": null,
15378
- "additionalTags": [],
15379
- "urlFragment": "#ipcmainremovehandlerchannel"
15380
- }
15381
- ],
15382
- "properties": [],
15383
- "events": [],
15384
- "exportedClasses": []
15385
- },
15386
- {
15387
- "name": "ipcRenderer",
15388
- "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.",
15389
- "slug": "ipc-renderer",
15390
- "websiteUrl": "https://electronjs.org/docs/api/ipc-renderer",
15391
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/ipc-renderer.md",
15392
- "version": "31.7.7",
15393
- "type": "Module",
15394
- "process": {
15395
- "main": false,
15396
- "renderer": true,
15397
- "utility": false,
15398
- "exported": true
15399
- },
15400
- "methods": [
15401
- {
15402
- "name": "on",
15403
- "signature": "(channel, listener)",
15404
- "description": "Listens to `channel`, when a new message arrives `listener` would be called with `listener(event, args...)`.",
15383
+ "name": "removeAllListeners",
15384
+ "signature": "([channel])",
15385
+ "description": "Removes all listeners from the specified `channel`. Removes all listeners from all channels if no channel is specified.",
15405
15386
  "parameters": [
15406
15387
  {
15407
15388
  "name": "channel",
15408
15389
  "description": "",
15409
- "required": true,
15390
+ "required": false,
15410
15391
  "collection": false,
15411
15392
  "type": "String",
15412
15393
  "possibleValues": null
15413
- },
15414
- {
15415
- "name": "listener",
15416
- "description": "",
15417
- "required": true,
15418
- "collection": false,
15419
- "type": "Function",
15420
- "parameters": [
15421
- {
15422
- "name": "event",
15423
- "description": "",
15424
- "required": true,
15425
- "collection": false,
15426
- "type": "IpcRendererEvent"
15427
- },
15428
- {
15429
- "name": "...args",
15430
- "description": "",
15431
- "required": true,
15432
- "collection": true,
15433
- "type": "any"
15434
- }
15435
- ],
15436
- "returns": null
15437
15394
  }
15438
15395
  ],
15439
15396
  "returns": null,
15440
15397
  "additionalTags": [],
15441
- "urlFragment": "#ipcrendereronchannel-listener"
15398
+ "urlFragment": "#ipcmainremovealllistenerschannel"
15442
15399
  },
15443
15400
  {
15444
- "name": "off",
15401
+ "name": "handle",
15445
15402
  "signature": "(channel, listener)",
15446
- "description": "Alias for `ipcRenderer.removeListener`.",
15403
+ "description": "Adds a handler for an `invoke`able IPC. This handler will be called whenever a renderer calls `ipcRenderer.invoke(channel, ...args)`.\n\nIf `listener` returns a Promise, the eventual result of the promise will be returned as a reply to the remote caller. Otherwise, the return value of the listener will be used as the value of the reply.\n\nThe `event` that is passed as the first argument to the handler is the same as that passed to a regular event listener. It includes information about which WebContents is the source of the invoke request.\n\nErrors thrown through `handle` in the main process are not transparent as they are serialized and only the `message` property from the original error is provided to the renderer process. Please refer to #24427 for details.",
15447
15404
  "parameters": [
15448
15405
  {
15449
15406
  "name": "channel",
@@ -15465,7 +15422,7 @@
15465
15422
  "description": "",
15466
15423
  "required": true,
15467
15424
  "collection": false,
15468
- "type": "IpcRendererEvent"
15425
+ "type": "IpcMainInvokeEvent"
15469
15426
  },
15470
15427
  {
15471
15428
  "name": "...args",
@@ -15475,17 +15432,217 @@
15475
15432
  "type": "any"
15476
15433
  }
15477
15434
  ],
15478
- "returns": null
15435
+ "returns": {
15436
+ "collection": false,
15437
+ "type": [
15438
+ {
15439
+ "collection": false,
15440
+ "type": "Promise",
15441
+ "innerTypes": [
15442
+ {
15443
+ "collection": false,
15444
+ "type": "any"
15445
+ }
15446
+ ]
15447
+ },
15448
+ {
15449
+ "collection": false,
15450
+ "type": "any"
15451
+ }
15452
+ ]
15453
+ }
15479
15454
  }
15480
15455
  ],
15481
15456
  "returns": null,
15482
15457
  "additionalTags": [],
15483
- "urlFragment": "#ipcrendereroffchannel-listener"
15458
+ "urlFragment": "#ipcmainhandlechannel-listener"
15484
15459
  },
15485
15460
  {
15486
- "name": "once",
15461
+ "name": "handleOnce",
15487
15462
  "signature": "(channel, listener)",
15488
- "description": "Adds a one time `listener` function for the event. This `listener` is invoked only the next time a message is sent to `channel`, after which it is removed.",
15463
+ "description": "Handles a single `invoke`able IPC message, then removes the listener. See `ipcMain.handle(channel, listener)`.",
15464
+ "parameters": [
15465
+ {
15466
+ "name": "channel",
15467
+ "description": "",
15468
+ "required": true,
15469
+ "collection": false,
15470
+ "type": "String",
15471
+ "possibleValues": null
15472
+ },
15473
+ {
15474
+ "name": "listener",
15475
+ "description": "",
15476
+ "required": true,
15477
+ "collection": false,
15478
+ "type": "Function",
15479
+ "parameters": [
15480
+ {
15481
+ "name": "event",
15482
+ "description": "",
15483
+ "required": true,
15484
+ "collection": false,
15485
+ "type": "IpcMainInvokeEvent"
15486
+ },
15487
+ {
15488
+ "name": "...args",
15489
+ "description": "",
15490
+ "required": true,
15491
+ "collection": true,
15492
+ "type": "any"
15493
+ }
15494
+ ],
15495
+ "returns": {
15496
+ "collection": false,
15497
+ "type": [
15498
+ {
15499
+ "collection": false,
15500
+ "type": "Promise",
15501
+ "innerTypes": [
15502
+ {
15503
+ "collection": false,
15504
+ "type": "any"
15505
+ }
15506
+ ]
15507
+ },
15508
+ {
15509
+ "collection": false,
15510
+ "type": "any"
15511
+ }
15512
+ ]
15513
+ }
15514
+ }
15515
+ ],
15516
+ "returns": null,
15517
+ "additionalTags": [],
15518
+ "urlFragment": "#ipcmainhandleoncechannel-listener"
15519
+ },
15520
+ {
15521
+ "name": "removeHandler",
15522
+ "signature": "(channel)",
15523
+ "description": "Removes any handler for `channel`, if present.",
15524
+ "parameters": [
15525
+ {
15526
+ "name": "channel",
15527
+ "description": "",
15528
+ "required": true,
15529
+ "collection": false,
15530
+ "type": "String",
15531
+ "possibleValues": null
15532
+ }
15533
+ ],
15534
+ "returns": null,
15535
+ "additionalTags": [],
15536
+ "urlFragment": "#ipcmainremovehandlerchannel"
15537
+ }
15538
+ ],
15539
+ "properties": [],
15540
+ "events": [],
15541
+ "exportedClasses": []
15542
+ },
15543
+ {
15544
+ "name": "ipcRenderer",
15545
+ "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.",
15546
+ "slug": "ipc-renderer",
15547
+ "websiteUrl": "https://electronjs.org/docs/api/ipc-renderer",
15548
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/ipc-renderer.md",
15549
+ "version": "34.3.0",
15550
+ "type": "Module",
15551
+ "process": {
15552
+ "main": false,
15553
+ "renderer": true,
15554
+ "utility": false,
15555
+ "exported": true
15556
+ },
15557
+ "methods": [
15558
+ {
15559
+ "name": "on",
15560
+ "signature": "(channel, listener)",
15561
+ "description": "Listens to `channel`, when a new message arrives `listener` would be called with `listener(event, args...)`.\n\n:::warning Do not expose the `event` argument to the renderer for security reasons! Wrap any callback that you receive from the renderer in another function like this: `ipcRenderer.on('my-channel', (event, ...args) => callback(...args))`. Not wrapping the callback in such a function would expose dangerous Electron APIs to the renderer process. See the security guide for more info. :::",
15562
+ "parameters": [
15563
+ {
15564
+ "name": "channel",
15565
+ "description": "",
15566
+ "required": true,
15567
+ "collection": false,
15568
+ "type": "String",
15569
+ "possibleValues": null
15570
+ },
15571
+ {
15572
+ "name": "listener",
15573
+ "description": "",
15574
+ "required": true,
15575
+ "collection": false,
15576
+ "type": "Function",
15577
+ "parameters": [
15578
+ {
15579
+ "name": "event",
15580
+ "description": "",
15581
+ "required": true,
15582
+ "collection": false,
15583
+ "type": "IpcRendererEvent"
15584
+ },
15585
+ {
15586
+ "name": "...args",
15587
+ "description": "",
15588
+ "required": true,
15589
+ "collection": true,
15590
+ "type": "any"
15591
+ }
15592
+ ],
15593
+ "returns": null
15594
+ }
15595
+ ],
15596
+ "returns": null,
15597
+ "additionalTags": [],
15598
+ "urlFragment": "#ipcrendereronchannel-listener"
15599
+ },
15600
+ {
15601
+ "name": "off",
15602
+ "signature": "(channel, listener)",
15603
+ "description": "Removes the specified `listener` from the listener array for the specified `channel`.",
15604
+ "parameters": [
15605
+ {
15606
+ "name": "channel",
15607
+ "description": "",
15608
+ "required": true,
15609
+ "collection": false,
15610
+ "type": "String",
15611
+ "possibleValues": null
15612
+ },
15613
+ {
15614
+ "name": "listener",
15615
+ "description": "",
15616
+ "required": true,
15617
+ "collection": false,
15618
+ "type": "Function",
15619
+ "parameters": [
15620
+ {
15621
+ "name": "event",
15622
+ "description": "",
15623
+ "required": true,
15624
+ "collection": false,
15625
+ "type": "IpcRendererEvent"
15626
+ },
15627
+ {
15628
+ "name": "...args",
15629
+ "description": "",
15630
+ "required": true,
15631
+ "collection": true,
15632
+ "type": "any"
15633
+ }
15634
+ ],
15635
+ "returns": null
15636
+ }
15637
+ ],
15638
+ "returns": null,
15639
+ "additionalTags": [],
15640
+ "urlFragment": "#ipcrendereroffchannel-listener"
15641
+ },
15642
+ {
15643
+ "name": "once",
15644
+ "signature": "(channel, listener)",
15645
+ "description": "Adds a one time `listener` function for the event. This `listener` is invoked only the next time a message is sent to `channel`, after which it is removed.",
15489
15646
  "parameters": [
15490
15647
  {
15491
15648
  "name": "channel",
@@ -15569,7 +15726,7 @@
15569
15726
  {
15570
15727
  "name": "removeListener",
15571
15728
  "signature": "(channel, listener)",
15572
- "description": "Removes the specified `listener` from the listener array for the specified `channel`.",
15729
+ "description": "Alias for `ipcRenderer.off`.",
15573
15730
  "parameters": [
15574
15731
  {
15575
15732
  "name": "channel",
@@ -15610,13 +15767,13 @@
15610
15767
  },
15611
15768
  {
15612
15769
  "name": "removeAllListeners",
15613
- "signature": "(channel)",
15614
- "description": "Removes all listeners, or those of the specified `channel`.",
15770
+ "signature": "([channel])",
15771
+ "description": "Removes all listeners from the specified `channel`. Removes all listeners from all channels if no channel is specified.",
15615
15772
  "parameters": [
15616
15773
  {
15617
15774
  "name": "channel",
15618
15775
  "description": "",
15619
- "required": true,
15776
+ "required": false,
15620
15777
  "collection": false,
15621
15778
  "type": "String",
15622
15779
  "possibleValues": null
@@ -15780,8 +15937,8 @@
15780
15937
  "description": "> Add items to native application menus and context menus.\n\nProcess: Main\n\nSee `Menu` for examples.",
15781
15938
  "slug": "menu-item",
15782
15939
  "websiteUrl": "https://electronjs.org/docs/api/menu-item",
15783
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/menu-item.md",
15784
- "version": "31.7.7",
15940
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/menu-item.md",
15941
+ "version": "34.3.0",
15785
15942
  "type": "Class",
15786
15943
  "process": {
15787
15944
  "main": true,
@@ -16677,8 +16834,8 @@
16677
16834
  "description": "\n\n### Class: Menu\n\n> Create native application menus and context menus.\n\nProcess: Main",
16678
16835
  "slug": "menu",
16679
16836
  "websiteUrl": "https://electronjs.org/docs/api/menu",
16680
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/menu.md",
16681
- "version": "31.7.7",
16837
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/menu.md",
16838
+ "version": "34.3.0",
16682
16839
  "type": "Class",
16683
16840
  "process": {
16684
16841
  "main": true,
@@ -16793,7 +16950,7 @@
16793
16950
  {
16794
16951
  "name": "popup",
16795
16952
  "signature": "([options])",
16796
- "description": "Pops up this menu as a context menu in the `BrowserWindow`.",
16953
+ "description": "Pops up this menu as a context menu in the `BaseWindow`.",
16797
16954
  "parameters": [
16798
16955
  {
16799
16956
  "name": "options",
@@ -16808,7 +16965,7 @@
16808
16965
  "required": false,
16809
16966
  "additionalTags": [],
16810
16967
  "collection": false,
16811
- "type": "BrowserWindow"
16968
+ "type": "BaseWindow"
16812
16969
  },
16813
16970
  {
16814
16971
  "name": "x",
@@ -16912,20 +17069,20 @@
16912
17069
  },
16913
17070
  {
16914
17071
  "name": "closePopup",
16915
- "signature": "([browserWindow])",
16916
- "description": "Closes the context menu in the `browserWindow`.",
17072
+ "signature": "([window])",
17073
+ "description": "Closes the context menu in the `window`.",
16917
17074
  "parameters": [
16918
17075
  {
16919
- "name": "browserWindow",
17076
+ "name": "window",
16920
17077
  "description": "Default is the focused window.",
16921
17078
  "required": false,
16922
17079
  "collection": false,
16923
- "type": "BrowserWindow"
17080
+ "type": "BaseWindow"
16924
17081
  }
16925
17082
  ],
16926
17083
  "returns": null,
16927
17084
  "additionalTags": [],
16928
- "urlFragment": "#menuclosepopupbrowserwindow"
17085
+ "urlFragment": "#menuclosepopupwindow"
16929
17086
  },
16930
17087
  {
16931
17088
  "name": "append",
@@ -17051,8 +17208,8 @@
17051
17208
  "description": "",
17052
17209
  "slug": "message-channel-main",
17053
17210
  "websiteUrl": "https://electronjs.org/docs/api/message-channel-main",
17054
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/message-channel-main.md",
17055
- "version": "31.7.7",
17211
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/message-channel-main.md",
17212
+ "version": "34.3.0",
17056
17213
  "type": "Class",
17057
17214
  "process": {
17058
17215
  "main": true,
@@ -17092,8 +17249,8 @@
17092
17249
  "description": "",
17093
17250
  "slug": "message-port-main",
17094
17251
  "websiteUrl": "https://electronjs.org/docs/api/message-port-main",
17095
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/message-port-main.md",
17096
- "version": "31.7.7",
17252
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/message-port-main.md",
17253
+ "version": "34.3.0",
17097
17254
  "type": "Class",
17098
17255
  "process": {
17099
17256
  "main": true,
@@ -17199,8 +17356,8 @@
17199
17356
  "description": "> Create tray, dock, and application icons using PNG or JPG files.\n\nProcess: Main, Renderer\n\nThe `nativeImage` module provides a unified interface for manipulating system images. These can be handy if you want to provide multiple scaled versions of the same icon or take advantage of macOS template images.\n\nElectron APIs that take image files accept either file paths or `NativeImage` instances. An empty and transparent image will be used when `null` is passed.\n\nFor example, when creating a Tray or setting a BrowserWindow's icon, you can either pass an image file path as a string:\n\n```\nconst { BrowserWindow, Tray } = require('electron')\n\nconst tray = new Tray('/Users/somebody/images/icon.png')\nconst win = new BrowserWindow({ icon: '/Users/somebody/images/window.png' })\n```\n\nor generate a `NativeImage` instance from the same file:\n\n### Supported Formats\n\nCurrently, `PNG` and `JPEG` image formats are supported across all platforms. `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, we recommend including at least the following sizes:\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 _Icon Scaling_ section in the Windows App Icon Construction reference.\n\n:::note\n\nEXIF metadata is currently not supported and will not be taken into account during image encoding and decoding.\n\n:::\n\n### High Resolution Image\n\nOn platforms that support high pixel density displays (such as Apple Retina), you can append `@2x` after image's base filename to mark it as a 2x scale 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 Dots per Inch (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 within Electron. For example:\n\n```\nimages/\n├── icon.png\n├── icon@2x.png\n└── icon@3x.png\n```\n\n```\nconst { Tray } = require('electron')\nconst appTray = new Tray('/Users/somebody/images/icon.png')\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 _macOS_\n\nOn macOS, template 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 (Tray) icon, so it can adapt to both light and dark menu bars.\n\nTo mark an image as a template image, its base filename should end with the word `Template` (e.g. `xxxTemplate.png`). You can also specify template images at different DPI densities (e.g. `xxxTemplate@2x.png`).",
17200
17357
  "slug": "native-image",
17201
17358
  "websiteUrl": "https://electronjs.org/docs/api/native-image",
17202
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/native-image.md",
17203
- "version": "31.7.7",
17359
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/native-image.md",
17360
+ "version": "34.3.0",
17204
17361
  "type": "Module",
17205
17362
  "process": {
17206
17363
  "main": true,
@@ -17446,8 +17603,8 @@
17446
17603
  "description": "",
17447
17604
  "slug": "native-image",
17448
17605
  "websiteUrl": "https://electronjs.org/docs/api/native-image",
17449
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/native-image.md",
17450
- "version": "31.7.7",
17606
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/native-image.md",
17607
+ "version": "34.3.0",
17451
17608
  "type": "Class",
17452
17609
  "process": {
17453
17610
  "main": true,
@@ -17869,8 +18026,8 @@
17869
18026
  "description": "> Read and respond to changes in Chromium's native color theme.\n\nProcess: Main",
17870
18027
  "slug": "native-theme",
17871
18028
  "websiteUrl": "https://electronjs.org/docs/api/native-theme",
17872
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/native-theme.md",
17873
- "version": "31.7.7",
18029
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/native-theme.md",
18030
+ "version": "34.3.0",
17874
18031
  "type": "Module",
17875
18032
  "process": {
17876
18033
  "main": true,
@@ -17980,8 +18137,8 @@
17980
18137
  "description": "",
17981
18138
  "slug": "navigation-history",
17982
18139
  "websiteUrl": "https://electronjs.org/docs/api/navigation-history",
17983
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/navigation-history.md",
17984
- "version": "31.7.7",
18140
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/navigation-history.md",
18141
+ "version": "34.3.0",
17985
18142
  "type": "Class",
17986
18143
  "process": {
17987
18144
  "main": true,
@@ -17993,6 +18150,59 @@
17993
18150
  "staticMethods": [],
17994
18151
  "staticProperties": [],
17995
18152
  "instanceMethods": [
18153
+ {
18154
+ "name": "canGoBack",
18155
+ "signature": "()",
18156
+ "description": "Whether the browser can go back to previous web page.",
18157
+ "parameters": [],
18158
+ "returns": {
18159
+ "collection": false,
18160
+ "type": "boolean"
18161
+ },
18162
+ "additionalTags": [],
18163
+ "urlFragment": "#navigationhistorycangoback"
18164
+ },
18165
+ {
18166
+ "name": "canGoForward",
18167
+ "signature": "()",
18168
+ "description": "Whether the browser can go forward to next web page.",
18169
+ "parameters": [],
18170
+ "returns": {
18171
+ "collection": false,
18172
+ "type": "boolean"
18173
+ },
18174
+ "additionalTags": [],
18175
+ "urlFragment": "#navigationhistorycangoforward"
18176
+ },
18177
+ {
18178
+ "name": "canGoToOffset",
18179
+ "signature": "(offset)",
18180
+ "description": "Whether the web page can go to the specified relative `offset` from the current entry.",
18181
+ "parameters": [
18182
+ {
18183
+ "name": "offset",
18184
+ "description": "",
18185
+ "required": true,
18186
+ "collection": false,
18187
+ "type": "Integer"
18188
+ }
18189
+ ],
18190
+ "returns": {
18191
+ "collection": false,
18192
+ "type": "boolean"
18193
+ },
18194
+ "additionalTags": [],
18195
+ "urlFragment": "#navigationhistorycangotooffsetoffset"
18196
+ },
18197
+ {
18198
+ "name": "clear",
18199
+ "signature": "()",
18200
+ "description": "Clears the navigation history.",
18201
+ "parameters": [],
18202
+ "returns": null,
18203
+ "additionalTags": [],
18204
+ "urlFragment": "#navigationhistoryclear"
18205
+ },
17996
18206
  {
17997
18207
  "name": "getActiveIndex",
17998
18208
  "signature": "()",
@@ -18008,7 +18218,7 @@
18008
18218
  {
18009
18219
  "name": "getEntryAtIndex",
18010
18220
  "signature": "(index)",
18011
- "description": "* `url` string - The URL of the navigation entry at the given index.\n* `title` string - The page title of the navigation entry at the given index.\n\nIf index is out of bounds (greater than history length or less than 0), null will be returned.",
18221
+ "description": "Navigation entry at the given index.\n\nIf index is out of bounds (greater than history length or less than 0), null will be returned.",
18012
18222
  "parameters": [
18013
18223
  {
18014
18224
  "name": "index",
@@ -18020,31 +18230,63 @@
18020
18230
  ],
18021
18231
  "returns": {
18022
18232
  "collection": false,
18023
- "type": "Object",
18024
- "properties": [
18025
- {
18026
- "name": "url",
18027
- "description": "The URL of the navigation entry at the given index.",
18028
- "required": true,
18029
- "additionalTags": [],
18030
- "collection": false,
18031
- "type": "String",
18032
- "possibleValues": null
18033
- },
18034
- {
18035
- "name": "title",
18036
- "description": "The page title of the navigation entry at the given index.",
18037
- "required": true,
18038
- "additionalTags": [],
18039
- "collection": false,
18040
- "type": "String",
18041
- "possibleValues": null
18042
- }
18043
- ]
18233
+ "type": "NavigationEntry"
18044
18234
  },
18045
18235
  "additionalTags": [],
18046
18236
  "urlFragment": "#navigationhistorygetentryatindexindex"
18047
18237
  },
18238
+ {
18239
+ "name": "goBack",
18240
+ "signature": "()",
18241
+ "description": "Makes the browser go back a web page.",
18242
+ "parameters": [],
18243
+ "returns": null,
18244
+ "additionalTags": [],
18245
+ "urlFragment": "#navigationhistorygoback"
18246
+ },
18247
+ {
18248
+ "name": "goForward",
18249
+ "signature": "()",
18250
+ "description": "Makes the browser go forward a web page.",
18251
+ "parameters": [],
18252
+ "returns": null,
18253
+ "additionalTags": [],
18254
+ "urlFragment": "#navigationhistorygoforward"
18255
+ },
18256
+ {
18257
+ "name": "goToIndex",
18258
+ "signature": "(index)",
18259
+ "description": "Navigates browser to the specified absolute web page index.",
18260
+ "parameters": [
18261
+ {
18262
+ "name": "index",
18263
+ "description": "",
18264
+ "required": true,
18265
+ "collection": false,
18266
+ "type": "Integer"
18267
+ }
18268
+ ],
18269
+ "returns": null,
18270
+ "additionalTags": [],
18271
+ "urlFragment": "#navigationhistorygotoindexindex"
18272
+ },
18273
+ {
18274
+ "name": "goToOffset",
18275
+ "signature": "(offset)",
18276
+ "description": "Navigates to the specified relative offset from the current entry.",
18277
+ "parameters": [
18278
+ {
18279
+ "name": "offset",
18280
+ "description": "",
18281
+ "required": true,
18282
+ "collection": false,
18283
+ "type": "Integer"
18284
+ }
18285
+ ],
18286
+ "returns": null,
18287
+ "additionalTags": [],
18288
+ "urlFragment": "#navigationhistorygotooffsetoffset"
18289
+ },
18048
18290
  {
18049
18291
  "name": "length",
18050
18292
  "signature": "()",
@@ -18056,6 +18298,82 @@
18056
18298
  },
18057
18299
  "additionalTags": [],
18058
18300
  "urlFragment": "#navigationhistorylength"
18301
+ },
18302
+ {
18303
+ "name": "removeEntryAtIndex",
18304
+ "signature": "(index)",
18305
+ "description": "Removes the navigation entry at the given index. Can't remove entry at the \"current active index\".\n\nWhether the navigation entry was removed from the webContents history.",
18306
+ "parameters": [
18307
+ {
18308
+ "name": "index",
18309
+ "description": "",
18310
+ "required": true,
18311
+ "collection": false,
18312
+ "type": "Integer"
18313
+ }
18314
+ ],
18315
+ "returns": {
18316
+ "collection": false,
18317
+ "type": "boolean"
18318
+ },
18319
+ "additionalTags": [],
18320
+ "urlFragment": "#navigationhistoryremoveentryatindexindex"
18321
+ },
18322
+ {
18323
+ "name": "getAllEntries",
18324
+ "signature": "()",
18325
+ "description": "WebContents complete history.",
18326
+ "parameters": [],
18327
+ "returns": {
18328
+ "collection": true,
18329
+ "type": "NavigationEntry"
18330
+ },
18331
+ "additionalTags": [],
18332
+ "urlFragment": "#navigationhistorygetallentries"
18333
+ },
18334
+ {
18335
+ "name": "restore",
18336
+ "signature": "(options)",
18337
+ "description": "the promise will resolve when the page has finished loading the selected navigation entry (see `did-finish-load`), and rejects if the page fails to load (see `did-fail-load`). A noop rejection handler is already attached, which avoids unhandled rejection errors.",
18338
+ "parameters": [
18339
+ {
18340
+ "name": "options",
18341
+ "description": "",
18342
+ "required": true,
18343
+ "collection": false,
18344
+ "type": "Object",
18345
+ "properties": [
18346
+ {
18347
+ "name": "entries",
18348
+ "description": "Result of a prior `getAllEntries()` call",
18349
+ "required": true,
18350
+ "additionalTags": [],
18351
+ "collection": true,
18352
+ "type": "NavigationEntry"
18353
+ },
18354
+ {
18355
+ "name": "index",
18356
+ "description": "Index of the stack that should be loaded. If you set it to `0`, the webContents will load the first (oldest) entry. If you leave it undefined, Electron will automatically load the last (newest) entry.",
18357
+ "required": false,
18358
+ "additionalTags": [],
18359
+ "collection": false,
18360
+ "type": "Integer"
18361
+ }
18362
+ ]
18363
+ }
18364
+ ],
18365
+ "returns": {
18366
+ "collection": false,
18367
+ "type": "Promise",
18368
+ "innerTypes": [
18369
+ {
18370
+ "collection": false,
18371
+ "type": "void"
18372
+ }
18373
+ ]
18374
+ },
18375
+ "additionalTags": [],
18376
+ "urlFragment": "#navigationhistoryrestoreoptions"
18059
18377
  }
18060
18378
  ],
18061
18379
  "instanceProperties": [],
@@ -18067,8 +18385,8 @@
18067
18385
  "description": "> Logging network events for a session.\n\nProcess: Main\n\n```\nconst { app, 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.",
18068
18386
  "slug": "net-log",
18069
18387
  "websiteUrl": "https://electronjs.org/docs/api/net-log",
18070
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/net-log.md",
18071
- "version": "31.7.7",
18388
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/net-log.md",
18389
+ "version": "34.3.0",
18072
18390
  "type": "Module",
18073
18391
  "process": {
18074
18392
  "main": true,
@@ -18183,8 +18501,8 @@
18183
18501
  "description": "> Issue HTTP/HTTPS requests using Chromium's native networking library\n\nProcess: Main, Utility\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.",
18184
18502
  "slug": "net",
18185
18503
  "websiteUrl": "https://electronjs.org/docs/api/net",
18186
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/net.md",
18187
- "version": "31.7.7",
18504
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/net.md",
18505
+ "version": "34.3.0",
18188
18506
  "type": "Module",
18189
18507
  "process": {
18190
18508
  "main": true,
@@ -18424,8 +18742,8 @@
18424
18742
  "description": "> Create OS desktop notifications\n\nProcess: Main\n\n:::info Renderer process notifications\n\nIf you want to show notifications from a renderer process you should use the web Notifications API\n\n:::\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",
18425
18743
  "slug": "notification",
18426
18744
  "websiteUrl": "https://electronjs.org/docs/api/notification",
18427
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/notification.md",
18428
- "version": "31.7.7",
18745
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/notification.md",
18746
+ "version": "34.3.0",
18429
18747
  "type": "Class",
18430
18748
  "process": {
18431
18749
  "main": true,
@@ -18482,7 +18800,7 @@
18482
18800
  },
18483
18801
  {
18484
18802
  "name": "icon",
18485
- "description": "An icon to use in the notification.",
18803
+ "description": "An icon to use in the notification. If a string is passed, it must be a valid path to a local icon file.",
18486
18804
  "required": false,
18487
18805
  "additionalTags": [],
18488
18806
  "collection": false,
@@ -18931,8 +19249,8 @@
18931
19249
  "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._",
18932
19250
  "slug": "parent-port",
18933
19251
  "websiteUrl": "https://electronjs.org/docs/api/parent-port",
18934
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/parent-port.md",
18935
- "version": "31.7.7",
19252
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/parent-port.md",
19253
+ "version": "34.3.0",
18936
19254
  "type": "Module",
18937
19255
  "process": {
18938
19256
  "main": false,
@@ -19003,8 +19321,8 @@
19003
19321
  "description": "> Monitor power state changes.\n\nProcess: Main",
19004
19322
  "slug": "power-monitor",
19005
19323
  "websiteUrl": "https://electronjs.org/docs/api/power-monitor",
19006
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/power-monitor.md",
19007
- "version": "31.7.7",
19324
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/power-monitor.md",
19325
+ "version": "34.3.0",
19008
19326
  "type": "Module",
19009
19327
  "process": {
19010
19328
  "main": true,
@@ -19160,7 +19478,48 @@
19160
19478
  {
19161
19479
  "name": "thermal-state-change",
19162
19480
  "description": "Emitted when the thermal state of the system changes. Notification of a change in the thermal status of the system, such as entering a critical temperature range. Depending on the severity, the system might take steps to reduce said temperature, for example, throttling the CPU or switching on the fans if available.\n\nApps may react to the new state by reducing expensive computing tasks (e.g. video encoding), or notifying the user. The same state might be received repeatedly.\n\nSee https://developer.apple.com/library/archive/documentation/Performance/Conceptual/power_efficiency_guidelines_osx/RespondToThermalStateChanges.html",
19163
- "parameters": [],
19481
+ "parameters": [
19482
+ {
19483
+ "name": "details",
19484
+ "description": "",
19485
+ "collection": false,
19486
+ "type": "Event",
19487
+ "eventProperties": [
19488
+ {
19489
+ "name": "state",
19490
+ "description": "The system's new thermal state. Can be `unknown`, `nominal`, `fair`, `serious`, `critical`.",
19491
+ "required": true,
19492
+ "additionalTags": [],
19493
+ "collection": false,
19494
+ "type": "String",
19495
+ "possibleValues": [
19496
+ {
19497
+ "value": "unknown",
19498
+ "description": ""
19499
+ },
19500
+ {
19501
+ "value": "nominal",
19502
+ "description": ""
19503
+ },
19504
+ {
19505
+ "value": "fair",
19506
+ "description": ""
19507
+ },
19508
+ {
19509
+ "value": "serious",
19510
+ "description": ""
19511
+ },
19512
+ {
19513
+ "value": "critical",
19514
+ "description": ""
19515
+ }
19516
+ ]
19517
+ }
19518
+ ],
19519
+ "additionalTags": [],
19520
+ "required": true
19521
+ }
19522
+ ],
19164
19523
  "additionalTags": [
19165
19524
  "os_macos"
19166
19525
  ],
@@ -19232,8 +19591,8 @@
19232
19591
  "description": "> Block the system from entering low-power (sleep) mode.\n\nProcess: Main\n\nFor example:",
19233
19592
  "slug": "power-save-blocker",
19234
19593
  "websiteUrl": "https://electronjs.org/docs/api/power-save-blocker",
19235
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/power-save-blocker.md",
19236
- "version": "31.7.7",
19594
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/power-save-blocker.md",
19595
+ "version": "34.3.0",
19237
19596
  "type": "Module",
19238
19597
  "process": {
19239
19598
  "main": true,
@@ -19322,8 +19681,8 @@
19322
19681
  "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* `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`",
19323
19682
  "slug": "process",
19324
19683
  "websiteUrl": "https://electronjs.org/docs/api/process",
19325
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/process.md",
19326
- "version": "31.7.7",
19684
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/process.md",
19685
+ "version": "34.3.0",
19327
19686
  "type": "Module",
19328
19687
  "process": {
19329
19688
  "main": true,
@@ -19839,8 +20198,8 @@
19839
20198
  "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, net } = require('electron')\nconst path = require('node:path')\nconst url = require('node:url')\n\napp.whenReady().then(() => {\n protocol.handle('atom', (request) => {\n const filePath = request.url.slice('atom://'.length)\n return net.fetch(url.pathToFileURL(path.join(__dirname, filePath)).toString())\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 { app, BrowserWindow, net, protocol, session } = require('electron')\nconst path = require('node:path')\nconst url = require('url')\n\napp.whenReady().then(() => {\n const partition = 'persist:example'\n const ses = session.fromPartition(partition)\n\n ses.protocol.handle('atom', (request) => {\n const filePath = request.url.slice('atom://'.length)\n return net.fetch(url.pathToFileURL(path.resolve(__dirname, filePath)).toString())\n })\n\n const mainWindow = new BrowserWindow({ webPreferences: { partition } })\n})\n```",
19840
20199
  "slug": "protocol",
19841
20200
  "websiteUrl": "https://electronjs.org/docs/api/protocol",
19842
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/protocol.md",
19843
- "version": "31.7.7",
20201
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/protocol.md",
20202
+ "version": "34.3.0",
19844
20203
  "type": "Module",
19845
20204
  "process": {
19846
20205
  "main": true,
@@ -20706,8 +21065,8 @@
20706
21065
  "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):",
20707
21066
  "slug": "push-notifications",
20708
21067
  "websiteUrl": "https://electronjs.org/docs/api/push-notifications",
20709
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/push-notifications.md",
20710
- "version": "31.7.7",
21068
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/push-notifications.md",
21069
+ "version": "34.3.0",
20711
21070
  "type": "Module",
20712
21071
  "process": {
20713
21072
  "main": true,
@@ -20796,8 +21155,8 @@
20796
21155
  "description": "> Allows access to simple encryption and decryption of strings for storage on the local machine.\n\nProcess: Main\n\nThis module adds extra protection to data being stored on disk by using OS-provided cryptography systems. Current security semantics for each platform are outlined below.\n\n* **macOS**: Encryption keys are stored for your app in Keychain Access in a way that prevents other applications from loading them without user override. Therefore, content is protected from other users and other apps running in the same userspace.\n* **Windows**: Encryption keys are generated via DPAPI. As per the Windows documentation: \"Typically, only a user with the same logon credential as the user who encrypted the data can typically decrypt the data\". Therefore, content is protected from other users on the same machine, but not from other apps running in the same userspace.\n* **Linux**: Encryption keys are generated and stored in a secret store that varies depending on your window manager and system setup. Options currently supported are `kwallet`, `kwallet5`, `kwallet6` and `gnome-libsecret`, but more may be available in future versions of Electron. As such, the security semantics of content protected via the `safeStorage` API vary between window managers and secret stores.\n * Note that not all Linux setups have an available secret store. If no secret store is available, items stored in using the `safeStorage` API will be unprotected as they are encrypted via hardcoded plaintext password. You can detect when this happens when `safeStorage.getSelectedStorageBackend()` returns `basic_text`.\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.",
20797
21156
  "slug": "safe-storage",
20798
21157
  "websiteUrl": "https://electronjs.org/docs/api/safe-storage",
20799
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/safe-storage.md",
20800
- "version": "31.7.7",
21158
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/safe-storage.md",
21159
+ "version": "34.3.0",
20801
21160
  "type": "Module",
20802
21161
  "process": {
20803
21162
  "main": true,
@@ -20927,8 +21286,8 @@
20927
21286
  "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```\n// Retrieve information about screen size, displays, cursor position, etc.\n//\n// For more info, see:\n// https://www.electronjs.org/docs/latest/api/screen\n\nconst { app, BrowserWindow, screen } = require('electron/main')\n\nlet mainWindow = null\n\napp.whenReady().then(() => {\n // Create a window that fills the screen's available work area.\n const primaryDisplay = screen.getPrimaryDisplay()\n const { width, height } = primaryDisplay.workAreaSize\n\n mainWindow = new BrowserWindow({ width, height })\n mainWindow.loadURL('https://electronjs.org')\n})\n```\n\nAnother example of creating a window in the external display:",
20928
21287
  "slug": "screen",
20929
21288
  "websiteUrl": "https://electronjs.org/docs/api/screen",
20930
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/screen.md",
20931
- "version": "31.7.7",
21289
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/screen.md",
21290
+ "version": "34.3.0",
20932
21291
  "type": "Module",
20933
21292
  "process": {
20934
21293
  "main": true,
@@ -21225,8 +21584,8 @@
21225
21584
  "description": "",
21226
21585
  "slug": "service-workers",
21227
21586
  "websiteUrl": "https://electronjs.org/docs/api/service-workers",
21228
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/service-workers.md",
21229
- "version": "31.7.7",
21587
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/service-workers.md",
21588
+ "version": "34.3.0",
21230
21589
  "type": "Class",
21231
21590
  "process": {
21232
21591
  "main": true,
@@ -21456,8 +21815,8 @@
21456
21815
  "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.",
21457
21816
  "slug": "session",
21458
21817
  "websiteUrl": "https://electronjs.org/docs/api/session",
21459
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/session.md",
21460
- "version": "31.7.7",
21818
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/session.md",
21819
+ "version": "34.3.0",
21461
21820
  "type": "Module",
21462
21821
  "process": {
21463
21822
  "main": true,
@@ -21488,7 +21847,7 @@
21488
21847
  "properties": [
21489
21848
  {
21490
21849
  "name": "cache",
21491
- "description": "Whether to enable cache.",
21850
+ "description": "Whether to enable cache. Default is `true` unless the `--disable-http-cache` switch is used.",
21492
21851
  "required": true,
21493
21852
  "additionalTags": [],
21494
21853
  "collection": false,
@@ -21526,7 +21885,7 @@
21526
21885
  "properties": [
21527
21886
  {
21528
21887
  "name": "cache",
21529
- "description": "Whether to enable cache.",
21888
+ "description": "Whether to enable cache. Default is `true` unless the `--disable-http-cache` switch is used.",
21530
21889
  "required": true,
21531
21890
  "additionalTags": [],
21532
21891
  "collection": false,
@@ -21562,8 +21921,8 @@
21562
21921
  "description": "",
21563
21922
  "slug": "session",
21564
21923
  "websiteUrl": "https://electronjs.org/docs/api/session",
21565
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/session.md",
21566
- "version": "31.7.7",
21924
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/session.md",
21925
+ "version": "34.3.0",
21567
21926
  "type": "Class",
21568
21927
  "process": {
21569
21928
  "main": true,
@@ -22463,6 +22822,10 @@
22463
22822
  {
22464
22823
  "value": "usb",
22465
22824
  "description": "Expose non-standard Universal Serial Bus (USB) compatible devices services to the web with the WebUSB API."
22825
+ },
22826
+ {
22827
+ "value": "deprecated-sync-clipboard-read",
22828
+ "description": "Request access to run `document.execCommand(\"paste\")`"
22466
22829
  }
22467
22830
  ]
22468
22831
  },
@@ -22559,8 +22922,8 @@
22559
22922
  },
22560
22923
  {
22561
22924
  "name": "setDisplayMediaRequestHandler",
22562
- "signature": "(handler)",
22563
- "description": "This handler will be called when web content requests access to display media via the `navigator.mediaDevices.getDisplayMedia` API. Use the desktopCapturer API to choose which stream(s) to grant access to.\n\nPassing a WebFrameMain object as a video or audio stream will capture the video or audio stream from that frame.\n\nPassing `null` instead of a function resets the handler to its default state.",
22925
+ "signature": "(handler[, opts])",
22926
+ "description": "This handler will be called when web content requests access to display media via the `navigator.mediaDevices.getDisplayMedia` API. Use the desktopCapturer API to choose which stream(s) to grant access to.\n\n`useSystemPicker` allows an application to use the system picker instead of providing a specific video source from `getSources`. This option is experimental, and currently available for MacOS 15+ only. If the system picker is available and `useSystemPicker` is set to `true`, the handler will not be invoked.\n\nPassing a WebFrameMain object as a video or audio stream will capture the video or audio stream from that frame.\n\nPassing `null` instead of a function resets the handler to its default state.",
22564
22927
  "parameters": [
22565
22928
  {
22566
22929
  "name": "handler",
@@ -22581,11 +22944,20 @@
22581
22944
  "properties": [
22582
22945
  {
22583
22946
  "name": "frame",
22584
- "description": "Frame that is requesting access to media.",
22947
+ "description": "Frame that is requesting access to media. May be `null` if accessed after the frame has either navigated or been destroyed.",
22585
22948
  "required": true,
22586
22949
  "additionalTags": [],
22587
22950
  "collection": false,
22588
- "type": "WebFrameMain"
22951
+ "type": [
22952
+ {
22953
+ "collection": false,
22954
+ "type": "WebFrameMain"
22955
+ },
22956
+ {
22957
+ "type": "null",
22958
+ "collection": false
22959
+ }
22960
+ ]
22589
22961
  },
22590
22962
  {
22591
22963
  "name": "securityOrigin",
@@ -22721,11 +23093,28 @@
22721
23093
  "collection": false
22722
23094
  }
22723
23095
  ]
23096
+ },
23097
+ {
23098
+ "name": "opts",
23099
+ "description": "",
23100
+ "required": false,
23101
+ "collection": false,
23102
+ "type": "Object",
23103
+ "properties": [
23104
+ {
23105
+ "name": "useSystemPicker",
23106
+ "description": "true if the available native system picker should be used. Default is `false`. _macOS_ _Experimental_",
23107
+ "required": true,
23108
+ "additionalTags": [],
23109
+ "collection": false,
23110
+ "type": "Boolean"
23111
+ }
23112
+ ]
22724
23113
  }
22725
23114
  ],
22726
23115
  "returns": null,
22727
23116
  "additionalTags": [],
22728
- "urlFragment": "#sessetdisplaymediarequesthandlerhandler"
23117
+ "urlFragment": "#sessetdisplaymediarequesthandlerhandler-opts"
22729
23118
  },
22730
23119
  {
22731
23120
  "name": "setDevicePermissionHandler",
@@ -22955,11 +23344,20 @@
22955
23344
  },
22956
23345
  {
22957
23346
  "name": "frame",
22958
- "description": "",
23347
+ "description": "The frame initiating this handler. May be `null` if accessed after the frame has either navigated or been destroyed.",
22959
23348
  "required": true,
22960
23349
  "additionalTags": [],
22961
23350
  "collection": false,
22962
- "type": "WebFrameMain"
23351
+ "type": [
23352
+ {
23353
+ "collection": false,
23354
+ "type": "WebFrameMain"
23355
+ },
23356
+ {
23357
+ "type": "null",
23358
+ "collection": false
23359
+ }
23360
+ ]
22963
23361
  },
22964
23362
  {
22965
23363
  "name": "pin",
@@ -23458,6 +23856,134 @@
23458
23856
  "additionalTags": [],
23459
23857
  "urlFragment": "#sesclearcodecachesoptions"
23460
23858
  },
23859
+ {
23860
+ "name": "getSharedDictionaryUsageInfo",
23861
+ "signature": "()",
23862
+ "description": "an array of shared dictionary information entries in Chromium's networking service's storage.\n\nShared dictionaries are used to power advanced compression of data sent over the wire, specifically with Brotli and ZStandard. You don't need to call any of the shared dictionary APIs in Electron to make use of this advanced web feature, but if you do, they allow deeper control and inspection of the shared dictionaries used during decompression.\n\nTo get detailed information about a specific shared dictionary entry, call `getSharedDictionaryInfo(options)`.",
23863
+ "parameters": [],
23864
+ "returns": {
23865
+ "collection": false,
23866
+ "type": "Promise",
23867
+ "innerTypes": [
23868
+ {
23869
+ "collection": true,
23870
+ "type": "SharedDictionaryUsageInfo"
23871
+ }
23872
+ ]
23873
+ },
23874
+ "additionalTags": [],
23875
+ "urlFragment": "#sesgetshareddictionaryusageinfo"
23876
+ },
23877
+ {
23878
+ "name": "getSharedDictionaryInfo",
23879
+ "signature": "(options)",
23880
+ "description": "an array of shared dictionary information entries in Chromium's networking service's storage.\n\nTo get information about all present shared dictionaries, call `getSharedDictionaryUsageInfo()`.",
23881
+ "parameters": [
23882
+ {
23883
+ "name": "options",
23884
+ "description": "",
23885
+ "required": true,
23886
+ "collection": false,
23887
+ "type": "Object",
23888
+ "properties": [
23889
+ {
23890
+ "name": "frameOrigin",
23891
+ "description": "The origin of the frame where the request originates. It’s specific to the individual frame making the request and is defined by its scheme, host, and port. In practice, will look like a URL.",
23892
+ "required": true,
23893
+ "additionalTags": [],
23894
+ "collection": false,
23895
+ "type": "String",
23896
+ "possibleValues": null
23897
+ },
23898
+ {
23899
+ "name": "topFrameSite",
23900
+ "description": "The site of the top-level browsing context (the main frame or tab that contains the request). It’s less granular than `frameOrigin` and focuses on the broader \"site\" scope. In practice, will look like a URL.",
23901
+ "required": true,
23902
+ "additionalTags": [],
23903
+ "collection": false,
23904
+ "type": "String",
23905
+ "possibleValues": null
23906
+ }
23907
+ ]
23908
+ }
23909
+ ],
23910
+ "returns": {
23911
+ "collection": false,
23912
+ "type": "Promise",
23913
+ "innerTypes": [
23914
+ {
23915
+ "collection": true,
23916
+ "type": "SharedDictionaryInfo"
23917
+ }
23918
+ ]
23919
+ },
23920
+ "additionalTags": [],
23921
+ "urlFragment": "#sesgetshareddictionaryinfooptions"
23922
+ },
23923
+ {
23924
+ "name": "clearSharedDictionaryCache",
23925
+ "signature": "()",
23926
+ "description": "resolves when the dictionary cache has been cleared, both in memory and on disk.",
23927
+ "parameters": [],
23928
+ "returns": {
23929
+ "collection": false,
23930
+ "type": "Promise",
23931
+ "innerTypes": [
23932
+ {
23933
+ "collection": false,
23934
+ "type": "void"
23935
+ }
23936
+ ]
23937
+ },
23938
+ "additionalTags": [],
23939
+ "urlFragment": "#sesclearshareddictionarycache"
23940
+ },
23941
+ {
23942
+ "name": "clearSharedDictionaryCacheForIsolationKey",
23943
+ "signature": "(options)",
23944
+ "description": "resolves when the dictionary cache has been cleared for the specified isolation key, both in memory and on disk.",
23945
+ "parameters": [
23946
+ {
23947
+ "name": "options",
23948
+ "description": "",
23949
+ "required": true,
23950
+ "collection": false,
23951
+ "type": "Object",
23952
+ "properties": [
23953
+ {
23954
+ "name": "frameOrigin",
23955
+ "description": "The origin of the frame where the request originates. It’s specific to the individual frame making the request and is defined by its scheme, host, and port. In practice, will look like a URL.",
23956
+ "required": true,
23957
+ "additionalTags": [],
23958
+ "collection": false,
23959
+ "type": "String",
23960
+ "possibleValues": null
23961
+ },
23962
+ {
23963
+ "name": "topFrameSite",
23964
+ "description": "The site of the top-level browsing context (the main frame or tab that contains the request). It’s less granular than `frameOrigin` and focuses on the broader \"site\" scope. In practice, will look like a URL.",
23965
+ "required": true,
23966
+ "additionalTags": [],
23967
+ "collection": false,
23968
+ "type": "String",
23969
+ "possibleValues": null
23970
+ }
23971
+ ]
23972
+ }
23973
+ ],
23974
+ "returns": {
23975
+ "collection": false,
23976
+ "type": "Promise",
23977
+ "innerTypes": [
23978
+ {
23979
+ "collection": false,
23980
+ "type": "void"
23981
+ }
23982
+ ]
23983
+ },
23984
+ "additionalTags": [],
23985
+ "urlFragment": "#sesclearshareddictionarycacheforisolationkeyoptions"
23986
+ },
23461
23987
  {
23462
23988
  "name": "setSpellCheckerEnabled",
23463
23989
  "signature": "(enable)",
@@ -23726,7 +24252,7 @@
23726
24252
  {
23727
24253
  "name": "clearData",
23728
24254
  "signature": "([options])",
23729
- "description": "resolves when all data has been cleared.\n\nClears various different types of data.\n\nThis method clears more types of data and is more thorough than the `clearStorageData` method.\n\n**Note:** Cookies are stored at a broader scope than origins. When removing cookies and filtering by `origins` (or `excludeOrigins`), the cookies will be removed at the registrable domain level. For example, clearing cookies for the origin `https://really.specific.origin.example.com/` will end up clearing all cookies for `example.com`. Clearing cookies for the origin `https://my.website.example.co.uk/` will end up clearing all cookies for `example.co.uk`.\n\nFor more information, refer to Chromium's `BrowsingDataRemover` interface.",
24255
+ "description": "resolves when all data has been cleared.\n\nClears various different types of data.\n\nThis method clears more types of data and is more thorough than the `clearStorageData` method.\n\n**Note:** Cookies are stored at a broader scope than origins. When removing cookies and filtering by `origins` (or `excludeOrigins`), the cookies will be removed at the registrable domain level. For example, clearing cookies for the origin `https://really.specific.origin.example.com/` will end up clearing all cookies for `example.com`. Clearing cookies for the origin `https://my.website.example.co.uk/` will end up clearing all cookies for `example.co.uk`.\n\n**Note:** Clearing cache data will also clear the shared dictionary cache. This means that any dictionaries used for compression may be reloaded after clearing the cache. If you wish to clear the shared dictionary cache but leave other cached data intact, you may want to use the `clearSharedDictionaryCache` method.\n\nFor more information, refer to Chromium's `BrowsingDataRemover` interface.",
23730
24256
  "parameters": [
23731
24257
  {
23732
24258
  "name": "options",
@@ -23737,7 +24263,7 @@
23737
24263
  "properties": [
23738
24264
  {
23739
24265
  "name": "dataTypes",
23740
- "description": "The types of data to clear. By default, this will clear all types of data.",
24266
+ "description": "The types of data to clear. By default, this will clear all types of data. This can potentially include data types not explicitly listed here. (See Chromium's `BrowsingDataRemover` for the full list.)",
23741
24267
  "required": false,
23742
24268
  "additionalTags": [],
23743
24269
  "collection": true,
@@ -23749,7 +24275,7 @@
23749
24275
  },
23750
24276
  {
23751
24277
  "value": "cache",
23752
- "description": "Cache"
24278
+ "description": "Cache (includes `cachestorage` and `shadercache`)"
23753
24279
  },
23754
24280
  {
23755
24281
  "value": "cookies",
@@ -24291,11 +24817,20 @@
24291
24817
  },
24292
24818
  {
24293
24819
  "name": "frame",
24294
- "description": "",
24820
+ "description": "The frame initiating this event. May be `null` if accessed after the frame has either navigated or been destroyed.",
24295
24821
  "required": true,
24296
24822
  "additionalTags": [],
24297
24823
  "collection": false,
24298
- "type": "WebFrameMain"
24824
+ "type": [
24825
+ {
24826
+ "collection": false,
24827
+ "type": "WebFrameMain"
24828
+ },
24829
+ {
24830
+ "type": "null",
24831
+ "collection": false
24832
+ }
24833
+ ]
24299
24834
  }
24300
24835
  ],
24301
24836
  "additionalTags": [],
@@ -24361,11 +24896,20 @@
24361
24896
  },
24362
24897
  {
24363
24898
  "name": "frame",
24364
- "description": "",
24899
+ "description": "The frame initiating this event. May be `null` if accessed after the frame has either navigated or been destroyed.",
24365
24900
  "required": true,
24366
24901
  "additionalTags": [],
24367
24902
  "collection": false,
24368
- "type": "WebFrameMain"
24903
+ "type": [
24904
+ {
24905
+ "collection": false,
24906
+ "type": "WebFrameMain"
24907
+ },
24908
+ {
24909
+ "type": "null",
24910
+ "collection": false
24911
+ }
24912
+ ]
24369
24913
  }
24370
24914
  ],
24371
24915
  "additionalTags": [],
@@ -24403,11 +24947,20 @@
24403
24947
  },
24404
24948
  {
24405
24949
  "name": "frame",
24406
- "description": "",
24950
+ "description": "The frame initiating this event. May be `null` if accessed after the frame has either navigated or been destroyed.",
24407
24951
  "required": true,
24408
24952
  "additionalTags": [],
24409
24953
  "collection": false,
24410
- "type": "WebFrameMain"
24954
+ "type": [
24955
+ {
24956
+ "collection": false,
24957
+ "type": "WebFrameMain"
24958
+ },
24959
+ {
24960
+ "type": "null",
24961
+ "collection": false
24962
+ }
24963
+ ]
24411
24964
  }
24412
24965
  ],
24413
24966
  "additionalTags": [],
@@ -24603,11 +25156,20 @@
24603
25156
  },
24604
25157
  {
24605
25158
  "name": "frame",
24606
- "description": "",
25159
+ "description": "The frame initiating this event. May be `null` if accessed after the frame has either navigated or been destroyed.",
24607
25160
  "required": true,
24608
25161
  "additionalTags": [],
24609
25162
  "collection": false,
24610
- "type": "WebFrameMain"
25163
+ "type": [
25164
+ {
25165
+ "collection": false,
25166
+ "type": "WebFrameMain"
25167
+ },
25168
+ {
25169
+ "type": "null",
25170
+ "collection": false
25171
+ }
25172
+ ]
24611
25173
  },
24612
25174
  {
24613
25175
  "name": "origin",
@@ -24654,11 +25216,20 @@
24654
25216
  },
24655
25217
  {
24656
25218
  "name": "frame",
24657
- "description": "",
25219
+ "description": "The frame initiating this event. May be `null` if accessed after the frame has either navigated or been destroyed.",
24658
25220
  "required": true,
24659
25221
  "additionalTags": [],
24660
25222
  "collection": false,
24661
- "type": "WebFrameMain"
25223
+ "type": [
25224
+ {
25225
+ "collection": false,
25226
+ "type": "WebFrameMain"
25227
+ },
25228
+ {
25229
+ "type": "null",
25230
+ "collection": false
25231
+ }
25232
+ ]
24662
25233
  }
24663
25234
  ],
24664
25235
  "additionalTags": [],
@@ -24802,8 +25373,8 @@
24802
25373
  "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",
24803
25374
  "slug": "share-menu",
24804
25375
  "websiteUrl": "https://electronjs.org/docs/api/share-menu",
24805
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/share-menu.md",
24806
- "version": "31.7.7",
25376
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/share-menu.md",
25377
+ "version": "34.3.0",
24807
25378
  "type": "Class",
24808
25379
  "process": {
24809
25380
  "main": true,
@@ -24870,8 +25441,8 @@
24870
25441
  "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.",
24871
25442
  "slug": "shell",
24872
25443
  "websiteUrl": "https://electronjs.org/docs/api/shell",
24873
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/shell.md",
24874
- "version": "31.7.7",
25444
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/shell.md",
25445
+ "version": "34.3.0",
24875
25446
  "type": "Module",
24876
25447
  "process": {
24877
25448
  "main": true,
@@ -24933,7 +25504,7 @@
24933
25504
  "parameters": [
24934
25505
  {
24935
25506
  "name": "url",
24936
- "description": "Max 2081 characters on windows.",
25507
+ "description": "Max 2081 characters on Windows.",
24937
25508
  "required": true,
24938
25509
  "collection": false,
24939
25510
  "type": "String",
@@ -25113,8 +25684,8 @@
25113
25684
  "description": "> Get system preferences.\n\nProcess: Main, Utility",
25114
25685
  "slug": "system-preferences",
25115
25686
  "websiteUrl": "https://electronjs.org/docs/api/system-preferences",
25116
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/system-preferences.md",
25117
- "version": "31.7.7",
25687
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/system-preferences.md",
25688
+ "version": "34.3.0",
25118
25689
  "type": "Module",
25119
25690
  "process": {
25120
25691
  "main": true,
@@ -26269,13 +26840,14 @@
26269
26840
  ],
26270
26841
  "properties": [
26271
26842
  {
26272
- "name": "accessibilityDisplayShouldReduceTransparency()",
26273
- "description": "A `boolean` property which determines whether the app avoids using semitransparent backgrounds. This maps to NSWorkspace.accessibilityDisplayShouldReduceTransparency",
26843
+ "name": "accessibilityDisplayShouldReduceTransparency",
26844
+ "description": "A `boolean` property which determines whether the app avoids using semitransparent backgrounds. This maps to NSWorkspace.accessibilityDisplayShouldReduceTransparency\n\n**Deprecated:** Use the new `nativeTheme.prefersReducedTransparency` API.",
26274
26845
  "required": true,
26275
26846
  "additionalTags": [
26276
- "os_macos"
26847
+ "os_macos",
26848
+ "stability_deprecated"
26277
26849
  ],
26278
- "urlFragment": "#systempreferencesaccessibilitydisplayshouldreducetransparency-macos",
26850
+ "urlFragment": "#systempreferencesaccessibilitydisplayshouldreducetransparency-macos-deprecated",
26279
26851
  "collection": false,
26280
26852
  "type": "boolean"
26281
26853
  },
@@ -26360,8 +26932,8 @@
26360
26932
  "description": "> Create a button in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
26361
26933
  "slug": "touch-bar-button",
26362
26934
  "websiteUrl": "https://electronjs.org/docs/api/touch-bar-button",
26363
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/touch-bar-button.md",
26364
- "version": "31.7.7",
26935
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/touch-bar-button.md",
26936
+ "version": "34.3.0",
26365
26937
  "type": "Class",
26366
26938
  "process": {
26367
26939
  "main": true,
@@ -26552,8 +27124,8 @@
26552
27124
  "description": "> Create a color picker in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
26553
27125
  "slug": "touch-bar-color-picker",
26554
27126
  "websiteUrl": "https://electronjs.org/docs/api/touch-bar-color-picker",
26555
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/touch-bar-color-picker.md",
26556
- "version": "31.7.7",
27127
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/touch-bar-color-picker.md",
27128
+ "version": "34.3.0",
26557
27129
  "type": "Class",
26558
27130
  "process": {
26559
27131
  "main": true,
@@ -26645,8 +27217,8 @@
26645
27217
  "description": "> Create a group in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
26646
27218
  "slug": "touch-bar-group",
26647
27219
  "websiteUrl": "https://electronjs.org/docs/api/touch-bar-group",
26648
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/touch-bar-group.md",
26649
- "version": "31.7.7",
27220
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/touch-bar-group.md",
27221
+ "version": "34.3.0",
26650
27222
  "type": "Class",
26651
27223
  "process": {
26652
27224
  "main": true,
@@ -26688,8 +27260,8 @@
26688
27260
  "description": "> Create a label in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
26689
27261
  "slug": "touch-bar-label",
26690
27262
  "websiteUrl": "https://electronjs.org/docs/api/touch-bar-label",
26691
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/touch-bar-label.md",
26692
- "version": "31.7.7",
27263
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/touch-bar-label.md",
27264
+ "version": "34.3.0",
26693
27265
  "type": "Class",
26694
27266
  "process": {
26695
27267
  "main": true,
@@ -26781,8 +27353,8 @@
26781
27353
  "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\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
26782
27354
  "slug": "touch-bar-other-items-proxy",
26783
27355
  "websiteUrl": "https://electronjs.org/docs/api/touch-bar-other-items-proxy",
26784
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/touch-bar-other-items-proxy.md",
26785
- "version": "31.7.7",
27356
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/touch-bar-other-items-proxy.md",
27357
+ "version": "34.3.0",
26786
27358
  "type": "Class",
26787
27359
  "process": {
26788
27360
  "main": true,
@@ -26806,8 +27378,8 @@
26806
27378
  "description": "> Create a popover in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
26807
27379
  "slug": "touch-bar-popover",
26808
27380
  "websiteUrl": "https://electronjs.org/docs/api/touch-bar-popover",
26809
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/touch-bar-popover.md",
26810
- "version": "31.7.7",
27381
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/touch-bar-popover.md",
27382
+ "version": "34.3.0",
26811
27383
  "type": "Class",
26812
27384
  "process": {
26813
27385
  "main": true,
@@ -26894,8 +27466,8 @@
26894
27466
  "description": "> Create a scrubber (a scrollable selector)\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
26895
27467
  "slug": "touch-bar-scrubber",
26896
27468
  "websiteUrl": "https://electronjs.org/docs/api/touch-bar-scrubber",
26897
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/touch-bar-scrubber.md",
26898
- "version": "31.7.7",
27469
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/touch-bar-scrubber.md",
27470
+ "version": "34.3.0",
26899
27471
  "type": "Class",
26900
27472
  "process": {
26901
27473
  "main": true,
@@ -27144,8 +27716,8 @@
27144
27716
  "description": "> Create a segmented control (a button group) where one button has a selected state\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
27145
27717
  "slug": "touch-bar-segmented-control",
27146
27718
  "websiteUrl": "https://electronjs.org/docs/api/touch-bar-segmented-control",
27147
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/touch-bar-segmented-control.md",
27148
- "version": "31.7.7",
27719
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/touch-bar-segmented-control.md",
27720
+ "version": "34.3.0",
27149
27721
  "type": "Class",
27150
27722
  "process": {
27151
27723
  "main": true,
@@ -27336,8 +27908,8 @@
27336
27908
  "description": "> Create a slider in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
27337
27909
  "slug": "touch-bar-slider",
27338
27910
  "websiteUrl": "https://electronjs.org/docs/api/touch-bar-slider",
27339
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/touch-bar-slider.md",
27340
- "version": "31.7.7",
27911
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/touch-bar-slider.md",
27912
+ "version": "34.3.0",
27341
27913
  "type": "Class",
27342
27914
  "process": {
27343
27915
  "main": true,
@@ -27460,8 +28032,8 @@
27460
28032
  "description": "> Create a spacer between two items in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
27461
28033
  "slug": "touch-bar-spacer",
27462
28034
  "websiteUrl": "https://electronjs.org/docs/api/touch-bar-spacer",
27463
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/touch-bar-spacer.md",
27464
- "version": "31.7.7",
28035
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/touch-bar-spacer.md",
28036
+ "version": "34.3.0",
27465
28037
  "type": "Class",
27466
28038
  "process": {
27467
28039
  "main": true,
@@ -27541,8 +28113,8 @@
27541
28113
  "description": "\n\n### Class: TouchBar\n\n> Create TouchBar layouts for native macOS applications\n\nProcess: Main",
27542
28114
  "slug": "touch-bar",
27543
28115
  "websiteUrl": "https://electronjs.org/docs/api/touch-bar",
27544
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/touch-bar.md",
27545
- "version": "31.7.7",
28116
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/touch-bar.md",
28117
+ "version": "34.3.0",
27546
28118
  "type": "Class",
27547
28119
  "process": {
27548
28120
  "main": true,
@@ -27771,8 +28343,8 @@
27771
28343
  "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.",
27772
28344
  "slug": "tray",
27773
28345
  "websiteUrl": "https://electronjs.org/docs/api/tray",
27774
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/tray.md",
27775
- "version": "31.7.7",
28346
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/tray.md",
28347
+ "version": "34.3.0",
27776
28348
  "type": "Class",
27777
28349
  "process": {
27778
28350
  "main": true,
@@ -28589,8 +29161,8 @@
28589
29161
  "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",
28590
29162
  "slug": "utility-process",
28591
29163
  "websiteUrl": "https://electronjs.org/docs/api/utility-process",
28592
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/utility-process.md",
28593
- "version": "31.7.7",
29164
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/utility-process.md",
29165
+ "version": "34.3.0",
28594
29166
  "type": "Module",
28595
29167
  "process": {
28596
29168
  "main": true,
@@ -28704,6 +29276,14 @@
28704
29276
  ],
28705
29277
  "collection": false,
28706
29278
  "type": "boolean"
29279
+ },
29280
+ {
29281
+ "name": "respondToAuthRequestsFromMainProcess",
29282
+ "description": "With this flag, all HTTP 401 and 407 network requests created via the net module will allow responding to them via the `app#login` event in the main process instead of the default `login` event on the `ClientRequest` object. Default is `false`.",
29283
+ "required": false,
29284
+ "additionalTags": [],
29285
+ "collection": false,
29286
+ "type": "boolean"
28707
29287
  }
28708
29288
  ]
28709
29289
  }
@@ -28725,8 +29305,8 @@
28725
29305
  "description": "",
28726
29306
  "slug": "utility-process",
28727
29307
  "websiteUrl": "https://electronjs.org/docs/api/utility-process",
28728
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/utility-process.md",
28729
- "version": "31.7.7",
29308
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/utility-process.md",
29309
+ "version": "34.3.0",
28730
29310
  "type": "Class",
28731
29311
  "process": {
28732
29312
  "main": true,
@@ -28778,7 +29358,7 @@
28778
29358
  "instanceProperties": [
28779
29359
  {
28780
29360
  "name": "pid",
28781
- "description": "A `Integer | undefined` representing the process identifier (PID) of the child process. If the child process fails to spawn due to errors, then the value is `undefined`. When the child process exits, then the value is `undefined` after the `exit` event is emitted.",
29361
+ "description": "A `Integer | undefined` representing the process identifier (PID) of the child process. Until the child process has spawned successfully, the value is `undefined`. When the child process exits, then the value is `undefined` after the `exit` event is emitted.\n\n**Note:** You can use the `pid` to determine if the process is currently running.",
28782
29362
  "required": true,
28783
29363
  "additionalTags": [],
28784
29364
  "urlFragment": "#childpid",
@@ -28839,13 +29419,55 @@
28839
29419
  "additionalTags": [],
28840
29420
  "urlFragment": "#event-spawn"
28841
29421
  },
29422
+ {
29423
+ "name": "error",
29424
+ "description": "Emitted when the child process needs to terminate due to non continuable error from V8.\n\nNo matter if you listen to the `error` event, the `exit` event will be emitted after the child process terminates.",
29425
+ "parameters": [
29426
+ {
29427
+ "name": "type",
29428
+ "description": "Type of error. One of the following values:",
29429
+ "collection": false,
29430
+ "type": "String",
29431
+ "possibleValues": [
29432
+ {
29433
+ "value": "FatalError",
29434
+ "description": ""
29435
+ }
29436
+ ],
29437
+ "additionalTags": [],
29438
+ "required": true
29439
+ },
29440
+ {
29441
+ "name": "location",
29442
+ "description": "Source location from where the error originated.",
29443
+ "collection": false,
29444
+ "type": "String",
29445
+ "possibleValues": null,
29446
+ "additionalTags": [],
29447
+ "required": true
29448
+ },
29449
+ {
29450
+ "name": "report",
29451
+ "description": "`Node.js diagnostic report`.",
29452
+ "collection": false,
29453
+ "type": "String",
29454
+ "possibleValues": null,
29455
+ "additionalTags": [],
29456
+ "required": true
29457
+ }
29458
+ ],
29459
+ "additionalTags": [
29460
+ "stability_experimental"
29461
+ ],
29462
+ "urlFragment": "#event-error-experimental"
29463
+ },
28842
29464
  {
28843
29465
  "name": "exit",
28844
29466
  "description": "Emitted after the child process ends.",
28845
29467
  "parameters": [
28846
29468
  {
28847
29469
  "name": "code",
28848
- "description": "Contains the exit code for the process obtained from waitpid on posix, or GetExitCodeProcess on windows.",
29470
+ "description": "Contains the exit code for the process obtained from waitpid on POSIX, or GetExitCodeProcess on Windows.",
28849
29471
  "collection": false,
28850
29472
  "type": "number",
28851
29473
  "additionalTags": [],
@@ -28879,8 +29501,8 @@
28879
29501
  "description": "> Create and layout native views.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Class: View\n\n> A basic native view.\n\nProcess: Main\n\n`View` is an EventEmitter.",
28880
29502
  "slug": "view",
28881
29503
  "websiteUrl": "https://electronjs.org/docs/api/view",
28882
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/view.md",
28883
- "version": "31.7.7",
29504
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/view.md",
29505
+ "version": "34.3.0",
28884
29506
  "type": "Class",
28885
29507
  "process": {
28886
29508
  "main": true,
@@ -28983,6 +29605,23 @@
28983
29605
  "additionalTags": [],
28984
29606
  "urlFragment": "#viewsetbackgroundcolorcolor"
28985
29607
  },
29608
+ {
29609
+ "name": "setBorderRadius",
29610
+ "signature": "(radius)",
29611
+ "description": "**Note:** The area cutout of the view's border still captures clicks.",
29612
+ "parameters": [
29613
+ {
29614
+ "name": "radius",
29615
+ "description": "Border radius size in pixels.",
29616
+ "required": true,
29617
+ "collection": false,
29618
+ "type": "Integer"
29619
+ }
29620
+ ],
29621
+ "returns": null,
29622
+ "additionalTags": [],
29623
+ "urlFragment": "#viewsetborderradiusradius"
29624
+ },
28986
29625
  {
28987
29626
  "name": "setVisible",
28988
29627
  "signature": "(visible)",
@@ -28999,6 +29638,18 @@
28999
29638
  "returns": null,
29000
29639
  "additionalTags": [],
29001
29640
  "urlFragment": "#viewsetvisiblevisible"
29641
+ },
29642
+ {
29643
+ "name": "getVisible",
29644
+ "signature": "()",
29645
+ "description": "Whether the view should be drawn. Note that this is different from whether the view is visible on screen—it may still be obscured or out of view.",
29646
+ "parameters": [],
29647
+ "returns": {
29648
+ "collection": false,
29649
+ "type": "boolean"
29650
+ },
29651
+ "additionalTags": [],
29652
+ "urlFragment": "#viewgetvisible"
29002
29653
  }
29003
29654
  ],
29004
29655
  "instanceProperties": [
@@ -29031,8 +29682,8 @@
29031
29682
  "description": "> A View that displays a WebContents.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Class: WebContentsView extends `View`\n\n> A View that displays a WebContents.\n\nProcess: Main\n\n`WebContentsView` inherits from `View`.\n\n`WebContentsView` is an EventEmitter.",
29032
29683
  "slug": "web-contents-view",
29033
29684
  "websiteUrl": "https://electronjs.org/docs/api/web-contents-view",
29034
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/web-contents-view.md",
29035
- "version": "31.7.7",
29685
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/web-contents-view.md",
29686
+ "version": "34.3.0",
29036
29687
  "type": "Class",
29037
29688
  "process": {
29038
29689
  "main": true,
@@ -29094,8 +29745,8 @@
29094
29745
  "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:\n\n### Navigation Events\n\nSeveral events can be used to monitor navigations as they occur within a `webContents`.\n\n### Document Navigations\n\nWhen a `webContents` navigates to another page (as opposed to an in-page navigation), the following events will be fired.\n\n* `did-start-navigation`\n* `will-frame-navigate`\n* `will-navigate` (only fired when main frame navigates)\n* `will-redirect` (only fired when a redirect happens during navigation)\n* `did-redirect-navigation` (only fired when a redirect happens during navigation)\n* `did-frame-navigate`\n* `did-navigate` (only fired when main frame navigates)\n\nSubsequent events will not fire if `event.preventDefault()` is called on any of the cancellable events.\n\n### In-page Navigation\n\nIn-page navigations don't cause the page to reload, but instead navigate to a location within the current page. These events are not cancellable. For an in-page navigations, the following events will fire in this order:\n\n* `did-start-navigation`\n* `did-navigate-in-page`\n\n### Frame Navigation\n\nThe `will-navigate` and `did-navigate` events only fire when the mainFrame navigates. If you want to also observe navigations in `<iframe>`s, use `will-frame-navigate` and `did-frame-navigate` events.",
29095
29746
  "slug": "web-contents",
29096
29747
  "websiteUrl": "https://electronjs.org/docs/api/web-contents",
29097
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/web-contents.md",
29098
- "version": "31.7.7",
29748
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/web-contents.md",
29749
+ "version": "34.3.0",
29099
29750
  "type": "Module",
29100
29751
  "process": {
29101
29752
  "main": true,
@@ -29235,8 +29886,8 @@
29235
29886
  "description": "",
29236
29887
  "slug": "web-contents",
29237
29888
  "websiteUrl": "https://electronjs.org/docs/api/web-contents",
29238
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/web-contents.md",
29239
- "version": "31.7.7",
29889
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/web-contents.md",
29890
+ "version": "34.3.0",
29240
29891
  "type": "Class",
29241
29892
  "process": {
29242
29893
  "main": true,
@@ -29619,31 +30270,35 @@
29619
30270
  {
29620
30271
  "name": "canGoBack",
29621
30272
  "signature": "()",
29622
- "description": "Whether the browser can go back to previous web page.",
30273
+ "description": "Whether the browser can go back to previous web page.\n\n**Deprecated:** Should use the new `contents.navigationHistory.canGoBack` API.",
29623
30274
  "parameters": [],
29624
30275
  "returns": {
29625
30276
  "collection": false,
29626
30277
  "type": "boolean"
29627
30278
  },
29628
- "additionalTags": [],
29629
- "urlFragment": "#contentscangoback"
30279
+ "additionalTags": [
30280
+ "stability_deprecated"
30281
+ ],
30282
+ "urlFragment": "#contentscangoback-deprecated"
29630
30283
  },
29631
30284
  {
29632
30285
  "name": "canGoForward",
29633
30286
  "signature": "()",
29634
- "description": "Whether the browser can go forward to next web page.",
30287
+ "description": "Whether the browser can go forward to next web page.\n\n**Deprecated:** Should use the new `contents.navigationHistory.canGoForward` API.",
29635
30288
  "parameters": [],
29636
30289
  "returns": {
29637
30290
  "collection": false,
29638
30291
  "type": "boolean"
29639
30292
  },
29640
- "additionalTags": [],
29641
- "urlFragment": "#contentscangoforward"
30293
+ "additionalTags": [
30294
+ "stability_deprecated"
30295
+ ],
30296
+ "urlFragment": "#contentscangoforward-deprecated"
29642
30297
  },
29643
30298
  {
29644
30299
  "name": "canGoToOffset",
29645
30300
  "signature": "(offset)",
29646
- "description": "Whether the web page can go to `offset`.",
30301
+ "description": "Whether the web page can go to `offset`.\n\n**Deprecated:** Should use the new `contents.navigationHistory.canGoToOffset` API.",
29647
30302
  "parameters": [
29648
30303
  {
29649
30304
  "name": "offset",
@@ -29657,40 +30312,48 @@
29657
30312
  "collection": false,
29658
30313
  "type": "boolean"
29659
30314
  },
29660
- "additionalTags": [],
29661
- "urlFragment": "#contentscangotooffsetoffset"
30315
+ "additionalTags": [
30316
+ "stability_deprecated"
30317
+ ],
30318
+ "urlFragment": "#contentscangotooffsetoffset-deprecated"
29662
30319
  },
29663
30320
  {
29664
30321
  "name": "clearHistory",
29665
30322
  "signature": "()",
29666
- "description": "Clears the navigation history.",
30323
+ "description": "Clears the navigation history.\n\n**Deprecated:** Should use the new `contents.navigationHistory.clear` API.",
29667
30324
  "parameters": [],
29668
30325
  "returns": null,
29669
- "additionalTags": [],
29670
- "urlFragment": "#contentsclearhistory"
30326
+ "additionalTags": [
30327
+ "stability_deprecated"
30328
+ ],
30329
+ "urlFragment": "#contentsclearhistory-deprecated"
29671
30330
  },
29672
30331
  {
29673
30332
  "name": "goBack",
29674
30333
  "signature": "()",
29675
- "description": "Makes the browser go back a web page.",
30334
+ "description": "Makes the browser go back a web page.\n\n**Deprecated:** Should use the new `contents.navigationHistory.goBack` API.",
29676
30335
  "parameters": [],
29677
30336
  "returns": null,
29678
- "additionalTags": [],
29679
- "urlFragment": "#contentsgoback"
30337
+ "additionalTags": [
30338
+ "stability_deprecated"
30339
+ ],
30340
+ "urlFragment": "#contentsgoback-deprecated"
29680
30341
  },
29681
30342
  {
29682
30343
  "name": "goForward",
29683
30344
  "signature": "()",
29684
- "description": "Makes the browser go forward a web page.",
30345
+ "description": "Makes the browser go forward a web page.\n\n**Deprecated:** Should use the new `contents.navigationHistory.goForward` API.",
29685
30346
  "parameters": [],
29686
30347
  "returns": null,
29687
- "additionalTags": [],
29688
- "urlFragment": "#contentsgoforward"
30348
+ "additionalTags": [
30349
+ "stability_deprecated"
30350
+ ],
30351
+ "urlFragment": "#contentsgoforward-deprecated"
29689
30352
  },
29690
30353
  {
29691
30354
  "name": "goToIndex",
29692
30355
  "signature": "(index)",
29693
- "description": "Navigates browser to the specified absolute web page index.",
30356
+ "description": "Navigates browser to the specified absolute web page index.\n\n**Deprecated:** Should use the new `contents.navigationHistory.goToIndex` API.",
29694
30357
  "parameters": [
29695
30358
  {
29696
30359
  "name": "index",
@@ -29701,13 +30364,15 @@
29701
30364
  }
29702
30365
  ],
29703
30366
  "returns": null,
29704
- "additionalTags": [],
29705
- "urlFragment": "#contentsgotoindexindex"
30367
+ "additionalTags": [
30368
+ "stability_deprecated"
30369
+ ],
30370
+ "urlFragment": "#contentsgotoindexindex-deprecated"
29706
30371
  },
29707
30372
  {
29708
30373
  "name": "goToOffset",
29709
30374
  "signature": "(offset)",
29710
- "description": "Navigates to the specified offset from the \"current entry\".",
30375
+ "description": "Navigates to the specified offset from the \"current entry\".\n\n**Deprecated:** Should use the new `contents.navigationHistory.goToOffset` API.",
29711
30376
  "parameters": [
29712
30377
  {
29713
30378
  "name": "offset",
@@ -29718,8 +30383,10 @@
29718
30383
  }
29719
30384
  ],
29720
30385
  "returns": null,
29721
- "additionalTags": [],
29722
- "urlFragment": "#contentsgotooffsetoffset"
30386
+ "additionalTags": [
30387
+ "stability_deprecated"
30388
+ ],
30389
+ "urlFragment": "#contentsgotooffsetoffset-deprecated"
29723
30390
  },
29724
30391
  {
29725
30392
  "name": "isCrashed",
@@ -30552,7 +31219,7 @@
30552
31219
  {
30553
31220
  "name": "isBeingCaptured",
30554
31221
  "signature": "()",
30555
- "description": "Whether this page is being captured. It returns true when the capturer count is large then 0.",
31222
+ "description": "Whether this page is being captured. It returns true when the capturer count is greater than 0.",
30556
31223
  "parameters": [],
30557
31224
  "returns": {
30558
31225
  "collection": false,
@@ -32717,11 +33384,20 @@
32717
33384
  },
32718
33385
  {
32719
33386
  "name": "frame",
32720
- "description": "The frame to be navigated.",
33387
+ "description": "The frame to be navigated. May be `null` if accessed after the frame has either navigated or been destroyed.",
32721
33388
  "required": true,
32722
33389
  "additionalTags": [],
32723
33390
  "collection": false,
32724
- "type": "WebFrameMain"
33391
+ "type": [
33392
+ {
33393
+ "collection": false,
33394
+ "type": "WebFrameMain"
33395
+ },
33396
+ {
33397
+ "type": "null",
33398
+ "collection": false
33399
+ }
33400
+ ]
32725
33401
  },
32726
33402
  {
32727
33403
  "name": "initiator",
@@ -32729,7 +33405,16 @@
32729
33405
  "required": false,
32730
33406
  "additionalTags": [],
32731
33407
  "collection": false,
32732
- "type": "WebFrameMain"
33408
+ "type": [
33409
+ {
33410
+ "collection": false,
33411
+ "type": "WebFrameMain"
33412
+ },
33413
+ {
33414
+ "type": "null",
33415
+ "collection": false
33416
+ }
33417
+ ]
32733
33418
  }
32734
33419
  ],
32735
33420
  "additionalTags": [],
@@ -32827,11 +33512,20 @@
32827
33512
  },
32828
33513
  {
32829
33514
  "name": "frame",
32830
- "description": "The frame to be navigated.",
33515
+ "description": "The frame to be navigated. May be `null` if accessed after the frame has either navigated or been destroyed.",
32831
33516
  "required": true,
32832
33517
  "additionalTags": [],
32833
33518
  "collection": false,
32834
- "type": "WebFrameMain"
33519
+ "type": [
33520
+ {
33521
+ "collection": false,
33522
+ "type": "WebFrameMain"
33523
+ },
33524
+ {
33525
+ "type": "null",
33526
+ "collection": false
33527
+ }
33528
+ ]
32835
33529
  },
32836
33530
  {
32837
33531
  "name": "initiator",
@@ -32839,7 +33533,16 @@
32839
33533
  "required": false,
32840
33534
  "additionalTags": [],
32841
33535
  "collection": false,
32842
- "type": "WebFrameMain"
33536
+ "type": [
33537
+ {
33538
+ "collection": false,
33539
+ "type": "WebFrameMain"
33540
+ },
33541
+ {
33542
+ "type": "null",
33543
+ "collection": false
33544
+ }
33545
+ ]
32843
33546
  }
32844
33547
  ],
32845
33548
  "additionalTags": [],
@@ -32886,11 +33589,20 @@
32886
33589
  },
32887
33590
  {
32888
33591
  "name": "frame",
32889
- "description": "The frame to be navigated.",
33592
+ "description": "The frame to be navigated. May be `null` if accessed after the frame has either navigated or been destroyed.",
32890
33593
  "required": true,
32891
33594
  "additionalTags": [],
32892
33595
  "collection": false,
32893
- "type": "WebFrameMain"
33596
+ "type": [
33597
+ {
33598
+ "collection": false,
33599
+ "type": "WebFrameMain"
33600
+ },
33601
+ {
33602
+ "type": "null",
33603
+ "collection": false
33604
+ }
33605
+ ]
32894
33606
  },
32895
33607
  {
32896
33608
  "name": "initiator",
@@ -32898,7 +33610,16 @@
32898
33610
  "required": false,
32899
33611
  "additionalTags": [],
32900
33612
  "collection": false,
32901
- "type": "WebFrameMain"
33613
+ "type": [
33614
+ {
33615
+ "collection": false,
33616
+ "type": "WebFrameMain"
33617
+ },
33618
+ {
33619
+ "type": "null",
33620
+ "collection": false
33621
+ }
33622
+ ]
32902
33623
  }
32903
33624
  ],
32904
33625
  "additionalTags": [],
@@ -32996,11 +33717,20 @@
32996
33717
  },
32997
33718
  {
32998
33719
  "name": "frame",
32999
- "description": "The frame to be navigated.",
33720
+ "description": "The frame to be navigated. May be `null` if accessed after the frame has either navigated or been destroyed.",
33000
33721
  "required": true,
33001
33722
  "additionalTags": [],
33002
33723
  "collection": false,
33003
- "type": "WebFrameMain"
33724
+ "type": [
33725
+ {
33726
+ "collection": false,
33727
+ "type": "WebFrameMain"
33728
+ },
33729
+ {
33730
+ "type": "null",
33731
+ "collection": false
33732
+ }
33733
+ ]
33004
33734
  },
33005
33735
  {
33006
33736
  "name": "initiator",
@@ -33008,7 +33738,16 @@
33008
33738
  "required": false,
33009
33739
  "additionalTags": [],
33010
33740
  "collection": false,
33011
- "type": "WebFrameMain"
33741
+ "type": [
33742
+ {
33743
+ "collection": false,
33744
+ "type": "WebFrameMain"
33745
+ },
33746
+ {
33747
+ "type": "null",
33748
+ "collection": false
33749
+ }
33750
+ ]
33012
33751
  }
33013
33752
  ],
33014
33753
  "additionalTags": [],
@@ -33106,11 +33845,20 @@
33106
33845
  },
33107
33846
  {
33108
33847
  "name": "frame",
33109
- "description": "The frame to be navigated.",
33848
+ "description": "The frame to be navigated. May be `null` if accessed after the frame has either navigated or been destroyed.",
33110
33849
  "required": true,
33111
33850
  "additionalTags": [],
33112
33851
  "collection": false,
33113
- "type": "WebFrameMain"
33852
+ "type": [
33853
+ {
33854
+ "collection": false,
33855
+ "type": "WebFrameMain"
33856
+ },
33857
+ {
33858
+ "type": "null",
33859
+ "collection": false
33860
+ }
33861
+ ]
33114
33862
  },
33115
33863
  {
33116
33864
  "name": "initiator",
@@ -33118,7 +33866,16 @@
33118
33866
  "required": false,
33119
33867
  "additionalTags": [],
33120
33868
  "collection": false,
33121
- "type": "WebFrameMain"
33869
+ "type": [
33870
+ {
33871
+ "collection": false,
33872
+ "type": "WebFrameMain"
33873
+ },
33874
+ {
33875
+ "type": "null",
33876
+ "collection": false
33877
+ }
33878
+ ]
33122
33879
  }
33123
33880
  ],
33124
33881
  "additionalTags": [],
@@ -34196,11 +34953,20 @@
34196
34953
  },
34197
34954
  {
34198
34955
  "name": "frame",
34199
- "description": "Frame from which the context menu was invoked.",
34956
+ "description": "Frame from which the context menu was invoked. May be `null` if accessed after the frame has either navigated or been destroyed.",
34200
34957
  "required": true,
34201
34958
  "additionalTags": [],
34202
34959
  "collection": false,
34203
- "type": "WebFrameMain"
34960
+ "type": [
34961
+ {
34962
+ "collection": false,
34963
+ "type": "WebFrameMain"
34964
+ },
34965
+ {
34966
+ "type": "null",
34967
+ "collection": false
34968
+ }
34969
+ ]
34204
34970
  },
34205
34971
  {
34206
34972
  "name": "linkURL",
@@ -34833,13 +35599,25 @@
34833
35599
  },
34834
35600
  {
34835
35601
  "name": "paint",
34836
- "description": "Emitted when a new frame is generated. Only the dirty area is passed in the buffer.",
35602
+ "description": "Emitted when a new frame is generated. Only the dirty area is passed in the buffer.\n\nWhen using shared texture (set `webPreferences.offscreen.useSharedTexture` to `true`) feature, you can pass the texture handle to external rendering pipeline without the overhead of copying data between CPU and GPU memory, with Chromium's hardware acceleration support. This feature is helpful for high-performance rendering scenarios.\n\nOnly a limited number of textures can exist at the same time, so it's important that you call `texture.release()` as soon as you're done with the texture. By managing the texture lifecycle by yourself, you can safely pass the `texture.textureInfo` to other processes through IPC.",
34837
35603
  "parameters": [
34838
35604
  {
34839
- "name": "event",
35605
+ "name": "details",
34840
35606
  "description": "",
34841
35607
  "collection": false,
34842
35608
  "type": "Event",
35609
+ "eventProperties": [
35610
+ {
35611
+ "name": "texture",
35612
+ "description": "The GPU shared texture of the frame, when `webPreferences.offscreen.useSharedTexture` is `true`.",
35613
+ "required": false,
35614
+ "additionalTags": [
35615
+ "stability_experimental"
35616
+ ],
35617
+ "collection": false,
35618
+ "type": "OffscreenSharedTexture"
35619
+ }
35620
+ ],
34843
35621
  "additionalTags": [],
34844
35622
  "required": true
34845
35623
  },
@@ -35131,11 +35909,20 @@
35131
35909
  "properties": [
35132
35910
  {
35133
35911
  "name": "frame",
35134
- "description": "",
35912
+ "description": "The created frame. May be `null` if accessed after the frame has either navigated or been destroyed.",
35135
35913
  "required": true,
35136
35914
  "additionalTags": [],
35137
35915
  "collection": false,
35138
- "type": "WebFrameMain"
35916
+ "type": [
35917
+ {
35918
+ "collection": false,
35919
+ "type": "WebFrameMain"
35920
+ },
35921
+ {
35922
+ "type": "null",
35923
+ "collection": false
35924
+ }
35925
+ ]
35139
35926
  }
35140
35927
  ],
35141
35928
  "additionalTags": [],
@@ -35153,8 +35940,8 @@
35153
35940
  "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`.",
35154
35941
  "slug": "web-frame-main",
35155
35942
  "websiteUrl": "https://electronjs.org/docs/api/web-frame-main",
35156
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/web-frame-main.md",
35157
- "version": "31.7.7",
35943
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/web-frame-main.md",
35944
+ "version": "34.3.0",
35158
35945
  "type": "Module",
35159
35946
  "process": {
35160
35947
  "main": true,
@@ -35209,8 +35996,8 @@
35209
35996
  "description": "",
35210
35997
  "slug": "web-frame-main",
35211
35998
  "websiteUrl": "https://electronjs.org/docs/api/web-frame-main",
35212
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/web-frame-main.md",
35213
- "version": "31.7.7",
35999
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/web-frame-main.md",
36000
+ "version": "34.3.0",
35214
36001
  "type": "Class",
35215
36002
  "process": {
35216
36003
  "main": true,
@@ -35268,6 +36055,18 @@
35268
36055
  "additionalTags": [],
35269
36056
  "urlFragment": "#framereload"
35270
36057
  },
36058
+ {
36059
+ "name": "isDestroyed",
36060
+ "signature": "()",
36061
+ "description": "Whether the frame is destroyed.",
36062
+ "parameters": [],
36063
+ "returns": {
36064
+ "collection": false,
36065
+ "type": "boolean"
36066
+ },
36067
+ "additionalTags": [],
36068
+ "urlFragment": "#frameisdestroyed"
36069
+ },
35271
36070
  {
35272
36071
  "name": "send",
35273
36072
  "signature": "(channel, ...args)",
@@ -35324,6 +36123,42 @@
35324
36123
  "returns": null,
35325
36124
  "additionalTags": [],
35326
36125
  "urlFragment": "#framepostmessagechannel-message-transfer"
36126
+ },
36127
+ {
36128
+ "name": "collectJavaScriptCallStack",
36129
+ "signature": "()",
36130
+ "description": "A promise that resolves with the currently running JavaScript call stack. If no JavaScript runs in the frame, the promise will never resolve. In cases where the call stack is otherwise unable to be collected, it will return `undefined`.\n\nThis can be useful to determine why the frame is unresponsive in cases where there's long-running JavaScript. For more information, see the proposed Crash Reporting API.",
36131
+ "parameters": [],
36132
+ "returns": {
36133
+ "collection": false,
36134
+ "type": [
36135
+ {
36136
+ "collection": false,
36137
+ "type": "Promise",
36138
+ "innerTypes": [
36139
+ {
36140
+ "collection": false,
36141
+ "type": "String",
36142
+ "possibleValues": null
36143
+ }
36144
+ ]
36145
+ },
36146
+ {
36147
+ "collection": false,
36148
+ "type": "Promise",
36149
+ "innerTypes": [
36150
+ {
36151
+ "collection": false,
36152
+ "type": "void"
36153
+ }
36154
+ ]
36155
+ }
36156
+ ]
36157
+ },
36158
+ "additionalTags": [
36159
+ "stability_experimental"
36160
+ ],
36161
+ "urlFragment": "#framecollectjavascriptcallstack-experimental"
35327
36162
  }
35328
36163
  ],
35329
36164
  "instanceProperties": [
@@ -35491,6 +36326,17 @@
35491
36326
  "collection": false,
35492
36327
  "type": "String",
35493
36328
  "possibleValues": null
36329
+ },
36330
+ {
36331
+ "name": "detached",
36332
+ "description": "A `Boolean` representing whether the frame is detached from the frame tree. If a frame is accessed while the corresponding page is running any unload listeners, it may become detached as the newly navigated page replaced it in the frame tree.",
36333
+ "required": true,
36334
+ "additionalTags": [
36335
+ "availability_readonly"
36336
+ ],
36337
+ "urlFragment": "#framedetached-readonly",
36338
+ "collection": false,
36339
+ "type": "Boolean"
35494
36340
  }
35495
36341
  ],
35496
36342
  "instanceEvents": [
@@ -35509,8 +36355,8 @@
35509
36355
  "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%.",
35510
36356
  "slug": "web-frame",
35511
36357
  "websiteUrl": "https://electronjs.org/docs/api/web-frame",
35512
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/web-frame.md",
35513
- "version": "31.7.7",
36358
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/web-frame.md",
36359
+ "version": "34.3.0",
35514
36360
  "type": "Module",
35515
36361
  "process": {
35516
36362
  "main": false,
@@ -35879,7 +36725,7 @@
35879
36725
  "parameters": [
35880
36726
  {
35881
36727
  "name": "worldId",
35882
- "description": "The ID of the world to run the javascript in, `0` is the default world, `999` is the world used by Electrons `contextIsolation` feature. Chrome extensions reserve the range of IDs in `[1 << 20, 1 << 29)`. You can provide any integer here.",
36728
+ "description": "The ID of the world to run the javascript in, `0` is the default world, `999` is the world used by Electron's `contextIsolation` feature. Chrome extensions reserve the range of IDs in `[1 << 20, 1 << 29)`. You can provide any integer here.",
35883
36729
  "required": true,
35884
36730
  "collection": false,
35885
36731
  "type": "Integer"
@@ -36223,8 +37069,8 @@
36223
37069
  "description": "",
36224
37070
  "slug": "web-request",
36225
37071
  "websiteUrl": "https://electronjs.org/docs/api/web-request",
36226
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/web-request.md",
36227
- "version": "31.7.7",
37072
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/web-request.md",
37073
+ "version": "34.3.0",
36228
37074
  "type": "Class",
36229
37075
  "process": {
36230
37076
  "main": true,
@@ -36309,11 +37155,20 @@
36309
37155
  },
36310
37156
  {
36311
37157
  "name": "frame",
36312
- "description": "",
37158
+ "description": "Requesting frame. May be `null` if accessed after the frame has either navigated or been destroyed.",
36313
37159
  "required": false,
36314
37160
  "additionalTags": [],
36315
37161
  "collection": false,
36316
- "type": "WebFrameMain"
37162
+ "type": [
37163
+ {
37164
+ "collection": false,
37165
+ "type": "WebFrameMain"
37166
+ },
37167
+ {
37168
+ "type": "null",
37169
+ "collection": false
37170
+ }
37171
+ ]
36317
37172
  },
36318
37173
  {
36319
37174
  "name": "resourceType",
@@ -36527,11 +37382,20 @@
36527
37382
  },
36528
37383
  {
36529
37384
  "name": "frame",
36530
- "description": "",
37385
+ "description": "Requesting frame. May be `null` if accessed after the frame has either navigated or been destroyed.",
36531
37386
  "required": false,
36532
37387
  "additionalTags": [],
36533
37388
  "collection": false,
36534
- "type": "WebFrameMain"
37389
+ "type": [
37390
+ {
37391
+ "collection": false,
37392
+ "type": "WebFrameMain"
37393
+ },
37394
+ {
37395
+ "type": "null",
37396
+ "collection": false
37397
+ }
37398
+ ]
36535
37399
  },
36536
37400
  {
36537
37401
  "name": "resourceType",
@@ -36786,11 +37650,20 @@
36786
37650
  },
36787
37651
  {
36788
37652
  "name": "frame",
36789
- "description": "",
37653
+ "description": "Requesting frame. May be `null` if accessed after the frame has either navigated or been destroyed.",
36790
37654
  "required": false,
36791
37655
  "additionalTags": [],
36792
37656
  "collection": false,
36793
- "type": "WebFrameMain"
37657
+ "type": [
37658
+ {
37659
+ "collection": false,
37660
+ "type": "WebFrameMain"
37661
+ },
37662
+ {
37663
+ "type": "null",
37664
+ "collection": false
37665
+ }
37666
+ ]
36794
37667
  },
36795
37668
  {
36796
37669
  "name": "resourceType",
@@ -36980,11 +37853,20 @@
36980
37853
  },
36981
37854
  {
36982
37855
  "name": "frame",
36983
- "description": "",
37856
+ "description": "Requesting frame. May be `null` if accessed after the frame has either navigated or been destroyed.",
36984
37857
  "required": false,
36985
37858
  "additionalTags": [],
36986
37859
  "collection": false,
36987
- "type": "WebFrameMain"
37860
+ "type": [
37861
+ {
37862
+ "collection": false,
37863
+ "type": "WebFrameMain"
37864
+ },
37865
+ {
37866
+ "type": "null",
37867
+ "collection": false
37868
+ }
37869
+ ]
36988
37870
  },
36989
37871
  {
36990
37872
  "name": "resourceType",
@@ -37257,11 +38139,20 @@
37257
38139
  },
37258
38140
  {
37259
38141
  "name": "frame",
37260
- "description": "",
38142
+ "description": "Requesting frame. May be `null` if accessed after the frame has either navigated or been destroyed.",
37261
38143
  "required": false,
37262
38144
  "additionalTags": [],
37263
38145
  "collection": false,
37264
- "type": "WebFrameMain"
38146
+ "type": [
38147
+ {
38148
+ "collection": false,
38149
+ "type": "WebFrameMain"
38150
+ },
38151
+ {
38152
+ "type": "null",
38153
+ "collection": false
38154
+ }
38155
+ ]
37265
38156
  },
37266
38157
  {
37267
38158
  "name": "resourceType",
@@ -37476,11 +38367,20 @@
37476
38367
  },
37477
38368
  {
37478
38369
  "name": "frame",
37479
- "description": "",
38370
+ "description": "Requesting frame. May be `null` if accessed after the frame has either navigated or been destroyed.",
37480
38371
  "required": false,
37481
38372
  "additionalTags": [],
37482
38373
  "collection": false,
37483
- "type": "WebFrameMain"
38374
+ "type": [
38375
+ {
38376
+ "collection": false,
38377
+ "type": "WebFrameMain"
38378
+ },
38379
+ {
38380
+ "type": "null",
38381
+ "collection": false
38382
+ }
38383
+ ]
37484
38384
  },
37485
38385
  {
37486
38386
  "name": "resourceType",
@@ -37713,11 +38613,20 @@
37713
38613
  },
37714
38614
  {
37715
38615
  "name": "frame",
37716
- "description": "",
38616
+ "description": "Requesting frame. May be `null` if accessed after the frame has either navigated or been destroyed.",
37717
38617
  "required": false,
37718
38618
  "additionalTags": [],
37719
38619
  "collection": false,
37720
- "type": "WebFrameMain"
38620
+ "type": [
38621
+ {
38622
+ "collection": false,
38623
+ "type": "WebFrameMain"
38624
+ },
38625
+ {
38626
+ "type": "null",
38627
+ "collection": false
38628
+ }
38629
+ ]
37721
38630
  },
37722
38631
  {
37723
38632
  "name": "resourceType",
@@ -37941,11 +38850,20 @@
37941
38850
  },
37942
38851
  {
37943
38852
  "name": "frame",
37944
- "description": "",
38853
+ "description": "Requesting frame. May be `null` if accessed after the frame has either navigated or been destroyed.",
37945
38854
  "required": false,
37946
38855
  "additionalTags": [],
37947
38856
  "collection": false,
37948
- "type": "WebFrameMain"
38857
+ "type": [
38858
+ {
38859
+ "collection": false,
38860
+ "type": "WebFrameMain"
38861
+ },
38862
+ {
38863
+ "type": "null",
38864
+ "collection": false
38865
+ }
38866
+ ]
37949
38867
  },
37950
38868
  {
37951
38869
  "name": "resourceType",
@@ -38069,8 +38987,8 @@
38069
38987
  "description": "> A utility layer to interact with Web API objects (Files, Blobs, etc.)\n\nProcess: Renderer",
38070
38988
  "slug": "web-utils",
38071
38989
  "websiteUrl": "https://electronjs.org/docs/api/web-utils",
38072
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/web-utils.md",
38073
- "version": "31.7.7",
38990
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/web-utils.md",
38991
+ "version": "34.3.0",
38074
38992
  "type": "Module",
38075
38993
  "process": {
38076
38994
  "main": false,
@@ -38111,8 +39029,8 @@
38111
39029
  "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`, a `WebContentsView`, 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\n _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=\"https://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=\"https://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=\"https://example.com/\"></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\nThis value can only be modified before the first navigation.\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.",
38112
39030
  "slug": "webview-tag",
38113
39031
  "websiteUrl": "https://electronjs.org/docs/api/webview-tag",
38114
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/webview-tag.md",
38115
- "version": "31.7.7",
39032
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/webview-tag.md",
39033
+ "version": "34.3.0",
38116
39034
  "type": "Element",
38117
39035
  "process": {
38118
39036
  "main": false,
@@ -41254,11 +42172,11 @@
41254
42172
  {
41255
42173
  "type": "Structure",
41256
42174
  "name": "BaseWindowConstructorOptions",
41257
- "description": "When setting minimum or maximum window size with `minWidth`/`maxWidth`/ `minHeight`/`maxHeight`, it only constrains the users. It won't prevent you from passing a size that does not follow size constraints to `setBounds`/`setSize` or to the constructor of `BrowserWindow`.\n\nThe possible values and behaviors of the `type` option are platform dependent. Possible values are:\n\n* On Linux, possible types are `desktop`, `dock`, `toolbar`, `splash`, `notification`.\n * The `desktop` type places the window at the desktop background window level (kCGDesktopWindowLevel - 1). However, note that a desktop window will not receive focus, keyboard, or mouse events. You can still use globalShortcut to receive input sparingly.\n * The `dock` type creates a dock-like window behavior.\n * The `toolbar` type creates a window with a toolbar appearance.\n * The `splash` type behaves in a specific way. It is not draggable, even if the CSS styling of the window's body contains -webkit-app-region: drag. This type is commonly used for splash screens.\n * The `notification` type creates a window that behaves like a system notification.\n* On macOS, possible types are `desktop`, `textured`, `panel`.\n * The `textured` type adds metal gradient appearance (`NSWindowStyleMaskTexturedBackground`).\n * The `desktop` type places the window at the desktop background window level (`kCGDesktopWindowLevel - 1`). Note that desktop window will not receive focus, keyboard or mouse events, but you can use `globalShortcut` to receive input sparingly.\n * The `panel` type enables the window to float on top of full-screened apps by adding the `NSWindowStyleMaskNonactivatingPanel` style mask,normally reserved for NSPanel, at runtime. Also, the window will appear on all spaces (desktops).\n* On Windows, possible type is `toolbar`.",
42175
+ "description": "When setting minimum or maximum window size with `minWidth`/`maxWidth`/ `minHeight`/`maxHeight`, it only constrains the users. It won't prevent you from passing a size that does not follow size constraints to `setBounds`/`setSize` or to the constructor of `BrowserWindow`.\n\nThe possible values and behaviors of the `type` option are platform dependent. Possible values are:\n\n* On Linux, possible types are `desktop`, `dock`, `toolbar`, `splash`, `notification`.\n * The `desktop` type places the window at the desktop background window level (kCGDesktopWindowLevel - 1). However, note that a desktop window will not receive focus, keyboard, or mouse events. You can still use globalShortcut to receive input sparingly.\n * The `dock` type creates a dock-like window behavior.\n * The `toolbar` type creates a window with a toolbar appearance.\n * The `splash` type behaves in a specific way. It is not draggable, even if the CSS styling of the window's body contains -webkit-app-region: drag. This type is commonly used for splash screens.\n * The `notification` type creates a window that behaves like a system notification.\n* On macOS, possible types are `desktop`, `textured`, `panel`.\n * The `textured` type adds metal gradient appearance. This option is **deprecated**.\n * The `desktop` type places the window at the desktop background window level (`kCGDesktopWindowLevel - 1`). Note that desktop window will not receive focus, keyboard or mouse events, but you can use `globalShortcut` to receive input sparingly.\n * The `panel` type enables the window to float on top of full-screened apps by adding the `NSWindowStyleMaskNonactivatingPanel` style mask,normally reserved for NSPanel, at runtime. Also, the window will appear on all spaces (desktops).\n* On Windows, possible type is `toolbar`.",
41258
42176
  "slug": "base-window-options",
41259
42177
  "websiteUrl": "https://electronjs.org/docs/api/structures/base-window-options",
41260
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/base-window-options.md",
41261
- "version": "31.7.7",
42178
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/base-window-options.md",
42179
+ "version": "34.3.0",
41262
42180
  "properties": [
41263
42181
  {
41264
42182
  "name": "width",
@@ -41723,10 +42641,11 @@
41723
42641
  },
41724
42642
  {
41725
42643
  "name": "roundedCorners",
41726
- "description": "Whether frameless window should have rounded corners on macOS. Default is `true`. Setting this property to `false` will prevent the window from being fullscreenable.",
42644
+ "description": "Whether frameless window should have rounded corners. Default is `true`. Setting this property to `false` will prevent the window from being fullscreenable on macOS. On Windows versions older than Windows 11 Build 22000 this property has no effect, and frameless windows will not have rounded corners.",
41727
42645
  "required": false,
41728
42646
  "additionalTags": [
41729
- "os_macos"
42647
+ "os_macos",
42648
+ "os_windows"
41730
42649
  ],
41731
42650
  "collection": false,
41732
42651
  "type": "boolean"
@@ -41872,8 +42791,8 @@
41872
42791
  "description": "",
41873
42792
  "slug": "bluetooth-device",
41874
42793
  "websiteUrl": "https://electronjs.org/docs/api/structures/bluetooth-device",
41875
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/bluetooth-device.md",
41876
- "version": "31.7.7",
42794
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/bluetooth-device.md",
42795
+ "version": "34.3.0",
41877
42796
  "properties": [
41878
42797
  {
41879
42798
  "name": "deviceName",
@@ -41902,8 +42821,8 @@
41902
42821
  "description": "",
41903
42822
  "slug": "browser-window-options",
41904
42823
  "websiteUrl": "https://electronjs.org/docs/api/structures/browser-window-options",
41905
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/browser-window-options.md",
41906
- "version": "31.7.7",
42824
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/browser-window-options.md",
42825
+ "version": "34.3.0",
41907
42826
  "properties": [
41908
42827
  {
41909
42828
  "name": "webPreferences",
@@ -41929,8 +42848,8 @@
41929
42848
  "description": "",
41930
42849
  "slug": "certificate-principal",
41931
42850
  "websiteUrl": "https://electronjs.org/docs/api/structures/certificate-principal",
41932
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/certificate-principal.md",
41933
- "version": "31.7.7",
42851
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/certificate-principal.md",
42852
+ "version": "34.3.0",
41934
42853
  "properties": [
41935
42854
  {
41936
42855
  "name": "commonName",
@@ -41994,8 +42913,8 @@
41994
42913
  "description": "",
41995
42914
  "slug": "certificate",
41996
42915
  "websiteUrl": "https://electronjs.org/docs/api/structures/certificate",
41997
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/certificate.md",
41998
- "version": "31.7.7",
42916
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/certificate.md",
42917
+ "version": "34.3.0",
41999
42918
  "properties": [
42000
42919
  {
42001
42920
  "name": "data",
@@ -42090,8 +43009,8 @@
42090
43009
  "description": "",
42091
43010
  "slug": "cookie",
42092
43011
  "websiteUrl": "https://electronjs.org/docs/api/structures/cookie",
42093
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/cookie.md",
42094
- "version": "31.7.7",
43012
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/cookie.md",
43013
+ "version": "34.3.0",
42095
43014
  "properties": [
42096
43015
  {
42097
43016
  "name": "name",
@@ -42203,8 +43122,8 @@
42203
43122
  "description": "",
42204
43123
  "slug": "cpu-usage",
42205
43124
  "websiteUrl": "https://electronjs.org/docs/api/structures/cpu-usage",
42206
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/cpu-usage.md",
42207
- "version": "31.7.7",
43125
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/cpu-usage.md",
43126
+ "version": "34.3.0",
42208
43127
  "properties": [
42209
43128
  {
42210
43129
  "name": "percentCPUUsage",
@@ -42214,6 +43133,14 @@
42214
43133
  "collection": false,
42215
43134
  "type": "number"
42216
43135
  },
43136
+ {
43137
+ "name": "cumulativeCPUUsage",
43138
+ "description": "Total seconds of CPU time used since process startup.",
43139
+ "required": false,
43140
+ "additionalTags": [],
43141
+ "collection": false,
43142
+ "type": "number"
43143
+ },
42217
43144
  {
42218
43145
  "name": "idleWakeupsPerSecond",
42219
43146
  "description": "The number of average idle CPU wakeups per second since the last call to getCPUUsage. First call returns 0. Will always return 0 on Windows.",
@@ -42230,8 +43157,8 @@
42230
43157
  "description": "",
42231
43158
  "slug": "crash-report",
42232
43159
  "websiteUrl": "https://electronjs.org/docs/api/structures/crash-report",
42233
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/crash-report.md",
42234
- "version": "31.7.7",
43160
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/crash-report.md",
43161
+ "version": "34.3.0",
42235
43162
  "properties": [
42236
43163
  {
42237
43164
  "name": "date",
@@ -42258,8 +43185,8 @@
42258
43185
  "description": "",
42259
43186
  "slug": "custom-scheme",
42260
43187
  "websiteUrl": "https://electronjs.org/docs/api/structures/custom-scheme",
42261
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/custom-scheme.md",
42262
- "version": "31.7.7",
43188
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/custom-scheme.md",
43189
+ "version": "34.3.0",
42263
43190
  "properties": [
42264
43191
  {
42265
43192
  "name": "scheme",
@@ -42352,8 +43279,8 @@
42352
43279
  "description": "",
42353
43280
  "slug": "desktop-capturer-source",
42354
43281
  "websiteUrl": "https://electronjs.org/docs/api/structures/desktop-capturer-source",
42355
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/desktop-capturer-source.md",
42356
- "version": "31.7.7",
43282
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/desktop-capturer-source.md",
43283
+ "version": "34.3.0",
42357
43284
  "properties": [
42358
43285
  {
42359
43286
  "name": "id",
@@ -42406,8 +43333,8 @@
42406
43333
  "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.",
42407
43334
  "slug": "display",
42408
43335
  "websiteUrl": "https://electronjs.org/docs/api/structures/display",
42409
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/display.md",
42410
- "version": "31.7.7",
43336
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/display.md",
43337
+ "version": "34.3.0",
42411
43338
  "properties": [
42412
43339
  {
42413
43340
  "name": "accelerometerSupport",
@@ -42599,8 +43526,8 @@
42599
43526
  "description": "",
42600
43527
  "slug": "extension-info",
42601
43528
  "websiteUrl": "https://electronjs.org/docs/api/structures/extension-info",
42602
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/extension-info.md",
42603
- "version": "31.7.7",
43529
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/extension-info.md",
43530
+ "version": "34.3.0",
42604
43531
  "properties": [
42605
43532
  {
42606
43533
  "name": "name",
@@ -42628,8 +43555,8 @@
42628
43555
  "description": "",
42629
43556
  "slug": "extension",
42630
43557
  "websiteUrl": "https://electronjs.org/docs/api/structures/extension",
42631
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/extension.md",
42632
- "version": "31.7.7",
43558
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/extension.md",
43559
+ "version": "34.3.0",
42633
43560
  "properties": [
42634
43561
  {
42635
43562
  "name": "id",
@@ -42692,8 +43619,8 @@
42692
43619
  "description": "",
42693
43620
  "slug": "file-filter",
42694
43621
  "websiteUrl": "https://electronjs.org/docs/api/structures/file-filter",
42695
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/file-filter.md",
42696
- "version": "31.7.7",
43622
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/file-filter.md",
43623
+ "version": "34.3.0",
42697
43624
  "properties": [
42698
43625
  {
42699
43626
  "name": "name",
@@ -42721,8 +43648,8 @@
42721
43648
  "description": "",
42722
43649
  "slug": "file-path-with-headers",
42723
43650
  "websiteUrl": "https://electronjs.org/docs/api/structures/file-path-with-headers",
42724
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/file-path-with-headers.md",
42725
- "version": "31.7.7",
43651
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/file-path-with-headers.md",
43652
+ "version": "34.3.0",
42726
43653
  "properties": [
42727
43654
  {
42728
43655
  "name": "path",
@@ -42762,8 +43689,8 @@
42762
43689
  "description": "",
42763
43690
  "slug": "filesystem-permission-request",
42764
43691
  "websiteUrl": "https://electronjs.org/docs/api/structures/filesystem-permission-request",
42765
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/filesystem-permission-request.md",
42766
- "version": "31.7.7",
43692
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/filesystem-permission-request.md",
43693
+ "version": "34.3.0",
42767
43694
  "properties": [
42768
43695
  {
42769
43696
  "name": "filePath",
@@ -42808,8 +43735,8 @@
42808
43735
  "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)",
42809
43736
  "slug": "gpu-feature-status",
42810
43737
  "websiteUrl": "https://electronjs.org/docs/api/structures/gpu-feature-status",
42811
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/gpu-feature-status.md",
42812
- "version": "31.7.7",
43738
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/gpu-feature-status.md",
43739
+ "version": "34.3.0",
42813
43740
  "properties": [
42814
43741
  {
42815
43742
  "name": "2d_canvas",
@@ -42936,8 +43863,8 @@
42936
43863
  "description": "",
42937
43864
  "slug": "hid-device",
42938
43865
  "websiteUrl": "https://electronjs.org/docs/api/structures/hid-device",
42939
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/hid-device.md",
42940
- "version": "31.7.7",
43866
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/hid-device.md",
43867
+ "version": "34.3.0",
42941
43868
  "properties": [
42942
43869
  {
42943
43870
  "name": "deviceId",
@@ -42999,8 +43926,8 @@
42999
43926
  "description": "",
43000
43927
  "slug": "input-event",
43001
43928
  "websiteUrl": "https://electronjs.org/docs/api/structures/input-event",
43002
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/input-event.md",
43003
- "version": "31.7.7",
43929
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/input-event.md",
43930
+ "version": "34.3.0",
43004
43931
  "properties": [
43005
43932
  {
43006
43933
  "name": "type",
@@ -43259,8 +44186,8 @@
43259
44186
  "description": "",
43260
44187
  "slug": "ipc-main-event",
43261
44188
  "websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-event",
43262
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/ipc-main-event.md",
43263
- "version": "31.7.7",
44189
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/ipc-main-event.md",
44190
+ "version": "34.3.0",
43264
44191
  "properties": [
43265
44192
  {
43266
44193
  "name": "processId",
@@ -43296,13 +44223,22 @@
43296
44223
  },
43297
44224
  {
43298
44225
  "name": "senderFrame",
43299
- "description": "The frame that sent this message",
44226
+ "description": "The frame that sent this message. May be `null` if accessed after the frame has either navigated or been destroyed.",
43300
44227
  "required": true,
43301
44228
  "additionalTags": [
43302
44229
  "availability_readonly"
43303
44230
  ],
43304
44231
  "collection": false,
43305
- "type": "WebFrameMain"
44232
+ "type": [
44233
+ {
44234
+ "collection": false,
44235
+ "type": "WebFrameMain"
44236
+ },
44237
+ {
44238
+ "type": "null",
44239
+ "collection": false
44240
+ }
44241
+ ]
43306
44242
  },
43307
44243
  {
43308
44244
  "name": "ports",
@@ -43347,8 +44283,8 @@
43347
44283
  "description": "",
43348
44284
  "slug": "ipc-main-invoke-event",
43349
44285
  "websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-invoke-event",
43350
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/ipc-main-invoke-event.md",
43351
- "version": "31.7.7",
44286
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/ipc-main-invoke-event.md",
44287
+ "version": "34.3.0",
43352
44288
  "properties": [
43353
44289
  {
43354
44290
  "name": "processId",
@@ -43376,13 +44312,22 @@
43376
44312
  },
43377
44313
  {
43378
44314
  "name": "senderFrame",
43379
- "description": "The frame that sent this message",
44315
+ "description": "The frame that sent this message. May be `null` if accessed after the frame has either navigated or been destroyed.",
43380
44316
  "required": true,
43381
44317
  "additionalTags": [
43382
44318
  "availability_readonly"
43383
44319
  ],
43384
44320
  "collection": false,
43385
- "type": "WebFrameMain"
44321
+ "type": [
44322
+ {
44323
+ "collection": false,
44324
+ "type": "WebFrameMain"
44325
+ },
44326
+ {
44327
+ "type": "null",
44328
+ "collection": false
44329
+ }
44330
+ ]
43386
44331
  }
43387
44332
  ]
43388
44333
  },
@@ -43393,8 +44338,8 @@
43393
44338
  "description": "",
43394
44339
  "slug": "ipc-renderer-event",
43395
44340
  "websiteUrl": "https://electronjs.org/docs/api/structures/ipc-renderer-event",
43396
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/ipc-renderer-event.md",
43397
- "version": "31.7.7",
44341
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/ipc-renderer-event.md",
44342
+ "version": "34.3.0",
43398
44343
  "properties": [
43399
44344
  {
43400
44345
  "name": "sender",
@@ -43420,8 +44365,8 @@
43420
44365
  "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.",
43421
44366
  "slug": "jump-list-category",
43422
44367
  "websiteUrl": "https://electronjs.org/docs/api/structures/jump-list-category",
43423
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/jump-list-category.md",
43424
- "version": "31.7.7",
44368
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/jump-list-category.md",
44369
+ "version": "34.3.0",
43425
44370
  "properties": [
43426
44371
  {
43427
44372
  "name": "type",
@@ -43474,8 +44419,8 @@
43474
44419
  "description": "",
43475
44420
  "slug": "jump-list-item",
43476
44421
  "websiteUrl": "https://electronjs.org/docs/api/structures/jump-list-item",
43477
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/jump-list-item.md",
43478
- "version": "31.7.7",
44422
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/jump-list-item.md",
44423
+ "version": "34.3.0",
43479
44424
  "properties": [
43480
44425
  {
43481
44426
  "name": "type",
@@ -43578,8 +44523,8 @@
43578
44523
  "description": "",
43579
44524
  "slug": "keyboard-event",
43580
44525
  "websiteUrl": "https://electronjs.org/docs/api/structures/keyboard-event",
43581
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/keyboard-event.md",
43582
- "version": "31.7.7",
44526
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/keyboard-event.md",
44527
+ "version": "34.3.0",
43583
44528
  "properties": [
43584
44529
  {
43585
44530
  "name": "ctrlKey",
@@ -43630,8 +44575,8 @@
43630
44575
  "description": "",
43631
44576
  "slug": "keyboard-input-event",
43632
44577
  "websiteUrl": "https://electronjs.org/docs/api/structures/keyboard-input-event",
43633
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/keyboard-input-event.md",
43634
- "version": "31.7.7",
44578
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/keyboard-input-event.md",
44579
+ "version": "34.3.0",
43635
44580
  "properties": [
43636
44581
  {
43637
44582
  "name": "type",
@@ -43677,8 +44622,8 @@
43677
44622
  "description": "",
43678
44623
  "slug": "media-access-permission-request",
43679
44624
  "websiteUrl": "https://electronjs.org/docs/api/structures/media-access-permission-request",
43680
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/media-access-permission-request.md",
43681
- "version": "31.7.7",
44625
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/media-access-permission-request.md",
44626
+ "version": "34.3.0",
43682
44627
  "properties": [
43683
44628
  {
43684
44629
  "name": "securityOrigin",
@@ -43715,8 +44660,8 @@
43715
44660
  "description": "Note that all statistics are reported in Kilobytes.",
43716
44661
  "slug": "memory-info",
43717
44662
  "websiteUrl": "https://electronjs.org/docs/api/structures/memory-info",
43718
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/memory-info.md",
43719
- "version": "31.7.7",
44663
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/memory-info.md",
44664
+ "version": "34.3.0",
43720
44665
  "properties": [
43721
44666
  {
43722
44667
  "name": "workingSetSize",
@@ -43752,8 +44697,8 @@
43752
44697
  "description": "",
43753
44698
  "slug": "memory-usage-details",
43754
44699
  "websiteUrl": "https://electronjs.org/docs/api/structures/memory-usage-details",
43755
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/memory-usage-details.md",
43756
- "version": "31.7.7",
44700
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/memory-usage-details.md",
44701
+ "version": "34.3.0",
43757
44702
  "properties": [
43758
44703
  {
43759
44704
  "name": "count",
@@ -43787,8 +44732,8 @@
43787
44732
  "description": "",
43788
44733
  "slug": "mime-typed-buffer",
43789
44734
  "websiteUrl": "https://electronjs.org/docs/api/structures/mime-typed-buffer",
43790
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/mime-typed-buffer.md",
43791
- "version": "31.7.7",
44735
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/mime-typed-buffer.md",
44736
+ "version": "34.3.0",
43792
44737
  "properties": [
43793
44738
  {
43794
44739
  "name": "mimeType",
@@ -43825,8 +44770,8 @@
43825
44770
  "description": "",
43826
44771
  "slug": "mouse-input-event",
43827
44772
  "websiteUrl": "https://electronjs.org/docs/api/structures/mouse-input-event",
43828
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/mouse-input-event.md",
43829
- "version": "31.7.7",
44773
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/mouse-input-event.md",
44774
+ "version": "34.3.0",
43830
44775
  "properties": [
43831
44776
  {
43832
44777
  "name": "type",
@@ -43953,8 +44898,8 @@
43953
44898
  "description": "",
43954
44899
  "slug": "mouse-wheel-input-event",
43955
44900
  "websiteUrl": "https://electronjs.org/docs/api/structures/mouse-wheel-input-event",
43956
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/mouse-wheel-input-event.md",
43957
- "version": "31.7.7",
44901
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/mouse-wheel-input-event.md",
44902
+ "version": "34.3.0",
43958
44903
  "properties": [
43959
44904
  {
43960
44905
  "name": "type",
@@ -44036,14 +44981,52 @@
44036
44981
  }
44037
44982
  ]
44038
44983
  },
44984
+ {
44985
+ "type": "Structure",
44986
+ "name": "NavigationEntry",
44987
+ "description": "",
44988
+ "slug": "navigation-entry",
44989
+ "websiteUrl": "https://electronjs.org/docs/api/structures/navigation-entry",
44990
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/navigation-entry.md",
44991
+ "version": "34.3.0",
44992
+ "properties": [
44993
+ {
44994
+ "name": "url",
44995
+ "description": "",
44996
+ "required": true,
44997
+ "additionalTags": [],
44998
+ "collection": false,
44999
+ "type": "String",
45000
+ "possibleValues": null
45001
+ },
45002
+ {
45003
+ "name": "title",
45004
+ "description": "",
45005
+ "required": true,
45006
+ "additionalTags": [],
45007
+ "collection": false,
45008
+ "type": "String",
45009
+ "possibleValues": null
45010
+ },
45011
+ {
45012
+ "name": "pageState",
45013
+ "description": "A base64 encoded data string containing Chromium page state including information like the current scroll position or form values. It is committed by Chromium before a navigation event and on a regular interval.",
45014
+ "required": false,
45015
+ "additionalTags": [],
45016
+ "collection": false,
45017
+ "type": "String",
45018
+ "possibleValues": null
45019
+ }
45020
+ ]
45021
+ },
44039
45022
  {
44040
45023
  "type": "Structure",
44041
45024
  "name": "NotificationAction",
44042
45025
  "description": "",
44043
45026
  "slug": "notification-action",
44044
45027
  "websiteUrl": "https://electronjs.org/docs/api/structures/notification-action",
44045
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/notification-action.md",
44046
- "version": "31.7.7",
45028
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/notification-action.md",
45029
+ "version": "34.3.0",
44047
45030
  "properties": [
44048
45031
  {
44049
45032
  "name": "type",
@@ -44076,8 +45059,8 @@
44076
45059
  "description": "",
44077
45060
  "slug": "notification-response",
44078
45061
  "websiteUrl": "https://electronjs.org/docs/api/structures/notification-response",
44079
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/notification-response.md",
44080
- "version": "31.7.7",
45062
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/notification-response.md",
45063
+ "version": "34.3.0",
44081
45064
  "properties": [
44082
45065
  {
44083
45066
  "name": "actionIdentifier",
@@ -44135,6 +45118,213 @@
44135
45118
  }
44136
45119
  ]
44137
45120
  },
45121
+ {
45122
+ "type": "Structure",
45123
+ "name": "OffscreenSharedTexture",
45124
+ "description": "",
45125
+ "slug": "offscreen-shared-texture",
45126
+ "websiteUrl": "https://electronjs.org/docs/api/structures/offscreen-shared-texture",
45127
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/offscreen-shared-texture.md",
45128
+ "version": "34.3.0",
45129
+ "properties": [
45130
+ {
45131
+ "name": "textureInfo",
45132
+ "description": "The shared texture info.",
45133
+ "required": true,
45134
+ "additionalTags": [],
45135
+ "collection": false,
45136
+ "type": "Object",
45137
+ "properties": [
45138
+ {
45139
+ "name": "widgetType",
45140
+ "description": "The widget type of the texture. Can be `popup` or `frame`.",
45141
+ "required": true,
45142
+ "additionalTags": [],
45143
+ "collection": false,
45144
+ "type": "String",
45145
+ "possibleValues": [
45146
+ {
45147
+ "value": "popup",
45148
+ "description": ""
45149
+ },
45150
+ {
45151
+ "value": "frame",
45152
+ "description": ""
45153
+ }
45154
+ ]
45155
+ },
45156
+ {
45157
+ "name": "pixelFormat",
45158
+ "description": "The pixel format of the texture. Can be `rgba` or `bgra`.",
45159
+ "required": true,
45160
+ "additionalTags": [],
45161
+ "collection": false,
45162
+ "type": "String",
45163
+ "possibleValues": [
45164
+ {
45165
+ "value": "rgba",
45166
+ "description": ""
45167
+ },
45168
+ {
45169
+ "value": "bgra",
45170
+ "description": ""
45171
+ }
45172
+ ]
45173
+ },
45174
+ {
45175
+ "name": "codedSize",
45176
+ "description": "The full dimensions of the video frame.",
45177
+ "required": true,
45178
+ "additionalTags": [],
45179
+ "collection": false,
45180
+ "type": "Size"
45181
+ },
45182
+ {
45183
+ "name": "visibleRect",
45184
+ "description": "A subsection of [0, 0, codedSize.width(), codedSize.height()]. In OSR case, it is expected to have the full section area.",
45185
+ "required": true,
45186
+ "additionalTags": [],
45187
+ "collection": false,
45188
+ "type": "Rectangle"
45189
+ },
45190
+ {
45191
+ "name": "contentRect",
45192
+ "description": "The region of the video frame that capturer would like to populate. In OSR case, it is the same with `dirtyRect` that needs to be painted.",
45193
+ "required": true,
45194
+ "additionalTags": [],
45195
+ "collection": false,
45196
+ "type": "Rectangle"
45197
+ },
45198
+ {
45199
+ "name": "timestamp",
45200
+ "description": "The time in microseconds since the capture start.",
45201
+ "required": true,
45202
+ "additionalTags": [],
45203
+ "collection": false,
45204
+ "type": "number"
45205
+ },
45206
+ {
45207
+ "name": "metadata",
45208
+ "description": "Extra metadata. See comments in src\\media\\base\\video_frame_metadata.h for accurate details.",
45209
+ "required": true,
45210
+ "additionalTags": [],
45211
+ "collection": false,
45212
+ "type": "Object",
45213
+ "properties": [
45214
+ {
45215
+ "name": "captureUpdateRect",
45216
+ "description": "Updated area of frame, can be considered as the `dirty` area.",
45217
+ "required": false,
45218
+ "additionalTags": [],
45219
+ "collection": false,
45220
+ "type": "Rectangle"
45221
+ },
45222
+ {
45223
+ "name": "regionCaptureRect",
45224
+ "description": "May reflect the frame's contents origin if region capture is used internally.",
45225
+ "required": false,
45226
+ "additionalTags": [],
45227
+ "collection": false,
45228
+ "type": "Rectangle"
45229
+ },
45230
+ {
45231
+ "name": "sourceSize",
45232
+ "description": "Full size of the source frame.",
45233
+ "required": false,
45234
+ "additionalTags": [],
45235
+ "collection": false,
45236
+ "type": "Rectangle"
45237
+ },
45238
+ {
45239
+ "name": "frameCount",
45240
+ "description": "The increasing count of captured frame. May contain gaps if frames are dropped between two consecutively received frames.",
45241
+ "required": false,
45242
+ "additionalTags": [],
45243
+ "collection": false,
45244
+ "type": "number"
45245
+ }
45246
+ ]
45247
+ },
45248
+ {
45249
+ "name": "sharedTextureHandle",
45250
+ "description": "The handle to the shared texture.",
45251
+ "required": true,
45252
+ "additionalTags": [
45253
+ "os_windows",
45254
+ "os_macos"
45255
+ ],
45256
+ "collection": false,
45257
+ "type": "Buffer"
45258
+ },
45259
+ {
45260
+ "name": "planes",
45261
+ "description": "Each plane's info of the shared texture.",
45262
+ "required": true,
45263
+ "additionalTags": [
45264
+ "os_linux"
45265
+ ],
45266
+ "collection": true,
45267
+ "type": "Object",
45268
+ "properties": [
45269
+ {
45270
+ "name": "stride",
45271
+ "description": "The strides and offsets in bytes to be used when accessing the buffers via a memory mapping. One per plane per entry.",
45272
+ "required": true,
45273
+ "additionalTags": [],
45274
+ "collection": false,
45275
+ "type": "number"
45276
+ },
45277
+ {
45278
+ "name": "offset",
45279
+ "description": "The strides and offsets in bytes to be used when accessing the buffers via a memory mapping. One per plane per entry.",
45280
+ "required": true,
45281
+ "additionalTags": [],
45282
+ "collection": false,
45283
+ "type": "number"
45284
+ },
45285
+ {
45286
+ "name": "size",
45287
+ "description": "Size in bytes of the plane. This is necessary to map the buffers.",
45288
+ "required": true,
45289
+ "additionalTags": [],
45290
+ "collection": false,
45291
+ "type": "number"
45292
+ },
45293
+ {
45294
+ "name": "fd",
45295
+ "description": "File descriptor for the underlying memory object (usually dmabuf).",
45296
+ "required": true,
45297
+ "additionalTags": [],
45298
+ "collection": false,
45299
+ "type": "number"
45300
+ }
45301
+ ]
45302
+ },
45303
+ {
45304
+ "name": "modifier",
45305
+ "description": "The modifier is retrieved from GBM library and passed to EGL driver.",
45306
+ "required": true,
45307
+ "additionalTags": [
45308
+ "os_linux"
45309
+ ],
45310
+ "collection": false,
45311
+ "type": "String",
45312
+ "possibleValues": null
45313
+ }
45314
+ ]
45315
+ },
45316
+ {
45317
+ "name": "release",
45318
+ "description": "Release the resources. The `texture` cannot be directly passed to another process, users need to maintain texture lifecycles in main process, but it is safe to pass the `textureInfo` to another process. Only a limited number of textures can exist at the same time, so it's important that you call `texture.release()` as soon as you're done with the texture.",
45319
+ "required": true,
45320
+ "additionalTags": [],
45321
+ "collection": false,
45322
+ "type": "Function",
45323
+ "parameters": [],
45324
+ "returns": null
45325
+ }
45326
+ ]
45327
+ },
44138
45328
  {
44139
45329
  "type": "Structure",
44140
45330
  "name": "OpenExternalPermissionRequest",
@@ -44142,8 +45332,8 @@
44142
45332
  "description": "",
44143
45333
  "slug": "open-external-permission-request",
44144
45334
  "websiteUrl": "https://electronjs.org/docs/api/structures/open-external-permission-request",
44145
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/open-external-permission-request.md",
44146
- "version": "31.7.7",
45335
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/open-external-permission-request.md",
45336
+ "version": "34.3.0",
44147
45337
  "properties": [
44148
45338
  {
44149
45339
  "name": "externalURL",
@@ -44162,8 +45352,8 @@
44162
45352
  "description": "",
44163
45353
  "slug": "payment-discount",
44164
45354
  "websiteUrl": "https://electronjs.org/docs/api/structures/payment-discount",
44165
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/payment-discount.md",
44166
- "version": "31.7.7",
45355
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/payment-discount.md",
45356
+ "version": "34.3.0",
44167
45357
  "properties": [
44168
45358
  {
44169
45359
  "name": "identifier",
@@ -44217,8 +45407,8 @@
44217
45407
  "description": "",
44218
45408
  "slug": "permission-request",
44219
45409
  "websiteUrl": "https://electronjs.org/docs/api/structures/permission-request",
44220
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/permission-request.md",
44221
- "version": "31.7.7",
45410
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/permission-request.md",
45411
+ "version": "34.3.0",
44222
45412
  "properties": [
44223
45413
  {
44224
45414
  "name": "requestingUrl",
@@ -44245,8 +45435,8 @@
44245
45435
  "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.",
44246
45436
  "slug": "point",
44247
45437
  "websiteUrl": "https://electronjs.org/docs/api/structures/point",
44248
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/point.md",
44249
- "version": "31.7.7",
45438
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/point.md",
45439
+ "version": "34.3.0",
44250
45440
  "properties": [
44251
45441
  {
44252
45442
  "name": "x",
@@ -44272,8 +45462,8 @@
44272
45462
  "description": "",
44273
45463
  "slug": "post-body",
44274
45464
  "websiteUrl": "https://electronjs.org/docs/api/structures/post-body",
44275
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/post-body.md",
44276
- "version": "31.7.7",
45465
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/post-body.md",
45466
+ "version": "34.3.0",
44277
45467
  "properties": [
44278
45468
  {
44279
45469
  "name": "data",
@@ -44318,8 +45508,8 @@
44318
45508
  "description": "",
44319
45509
  "slug": "printer-info",
44320
45510
  "websiteUrl": "https://electronjs.org/docs/api/structures/printer-info",
44321
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/printer-info.md",
44322
- "version": "31.7.7",
45511
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/printer-info.md",
45512
+ "version": "34.3.0",
44323
45513
  "properties": [
44324
45514
  {
44325
45515
  "name": "name",
@@ -44381,8 +45571,8 @@
44381
45571
  "description": "",
44382
45572
  "slug": "process-memory-info",
44383
45573
  "websiteUrl": "https://electronjs.org/docs/api/structures/process-memory-info",
44384
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/process-memory-info.md",
44385
- "version": "31.7.7",
45574
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/process-memory-info.md",
45575
+ "version": "34.3.0",
44386
45576
  "properties": [
44387
45577
  {
44388
45578
  "name": "residentSet",
@@ -44419,8 +45609,8 @@
44419
45609
  "description": "",
44420
45610
  "slug": "process-metric",
44421
45611
  "websiteUrl": "https://electronjs.org/docs/api/structures/process-metric",
44422
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/process-metric.md",
44423
- "version": "31.7.7",
45612
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/process-metric.md",
45613
+ "version": "34.3.0",
44424
45614
  "properties": [
44425
45615
  {
44426
45616
  "name": "pid",
@@ -44569,8 +45759,8 @@
44569
45759
  "description": "",
44570
45760
  "slug": "product-discount",
44571
45761
  "websiteUrl": "https://electronjs.org/docs/api/structures/product-discount",
44572
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/product-discount.md",
44573
- "version": "31.7.7",
45762
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/product-discount.md",
45763
+ "version": "34.3.0",
44574
45764
  "properties": [
44575
45765
  {
44576
45766
  "name": "identifier",
@@ -44652,8 +45842,8 @@
44652
45842
  "description": "",
44653
45843
  "slug": "product-subscription-period",
44654
45844
  "websiteUrl": "https://electronjs.org/docs/api/structures/product-subscription-period",
44655
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/product-subscription-period.md",
44656
- "version": "31.7.7",
45845
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/product-subscription-period.md",
45846
+ "version": "34.3.0",
44657
45847
  "properties": [
44658
45848
  {
44659
45849
  "name": "numberOfUnits",
@@ -44697,8 +45887,8 @@
44697
45887
  "description": "",
44698
45888
  "slug": "product",
44699
45889
  "websiteUrl": "https://electronjs.org/docs/api/structures/product",
44700
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/product.md",
44701
- "version": "31.7.7",
45890
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/product.md",
45891
+ "version": "34.3.0",
44702
45892
  "properties": [
44703
45893
  {
44704
45894
  "name": "productIdentifier",
@@ -44819,8 +46009,8 @@
44819
46009
  "description": "",
44820
46010
  "slug": "protocol-request",
44821
46011
  "websiteUrl": "https://electronjs.org/docs/api/structures/protocol-request",
44822
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/protocol-request.md",
44823
- "version": "31.7.7",
46012
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/protocol-request.md",
46013
+ "version": "34.3.0",
44824
46014
  "properties": [
44825
46015
  {
44826
46016
  "name": "url",
@@ -44885,8 +46075,8 @@
44885
46075
  "description": "",
44886
46076
  "slug": "protocol-response-upload-data",
44887
46077
  "websiteUrl": "https://electronjs.org/docs/api/structures/protocol-response-upload-data",
44888
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/protocol-response-upload-data.md",
44889
- "version": "31.7.7",
46078
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/protocol-response-upload-data.md",
46079
+ "version": "34.3.0",
44890
46080
  "properties": [
44891
46081
  {
44892
46082
  "name": "contentType",
@@ -44923,8 +46113,8 @@
44923
46113
  "description": "",
44924
46114
  "slug": "protocol-response",
44925
46115
  "websiteUrl": "https://electronjs.org/docs/api/structures/protocol-response",
44926
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/protocol-response.md",
44927
- "version": "31.7.7",
46116
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/protocol-response.md",
46117
+ "version": "34.3.0",
44928
46118
  "properties": [
44929
46119
  {
44930
46120
  "name": "error",
@@ -45072,8 +46262,8 @@
45072
46262
  "description": "When `mode` is unspecified, `pacScript` and `proxyRules` are provided together, the `proxyRules` option is ignored and `pacScript` configuration is applied.\n\nThe `proxyRules` has to follow the rules below:\n\nFor example:\n\n* `http=foopy:80;ftp=foopy2` - Use HTTP proxy `foopy:80` for `http://` URLs, and HTTP proxy `foopy2:80` for `ftp://` URLs.\n* `foopy:80` - Use HTTP proxy `foopy:80` for all URLs.\n* `foopy:80,bar,direct://` - Use HTTP proxy `foopy:80` for all URLs, failing over to `bar` if `foopy:80` is unavailable, and after that using no proxy.\n* `socks4://foopy` - Use SOCKS v4 proxy `foopy:1080` for all URLs.\n* `http=foopy,socks5://bar.com` - Use HTTP proxy `foopy` for http URLs, and fail over to the SOCKS5 proxy `bar.com` if `foopy` is unavailable.\n* `http=foopy,direct://` - Use HTTP proxy `foopy` for http URLs, and use no proxy if `foopy` is unavailable.\n* `http=foopy;socks=foopy2` - Use HTTP proxy `foopy` for http URLs, and use `socks4://foopy2` for all other URLs.\n\nThe `proxyBypassRules` is a comma separated list of rules described below:\n\n* `[ URL_SCHEME \"://\" ] HOSTNAME_PATTERN [ \":\" <port> ]`\n\nMatch all hostnames that match the pattern HOSTNAME_PATTERN.\n\nExamples: \"foobar.com\", \"*foobar.com\", \"*.foobar.com\", \"*foobar.com:99\", \"https://x.*.y.com:99\"\n* `\".\" HOSTNAME_SUFFIX_PATTERN [ \":\" PORT ]`\n\nMatch a particular domain suffix.\n\nExamples: \".google.com\", \".com\", \"http://.google.com\"\n* `[ SCHEME \"://\" ] IP_LITERAL [ \":\" PORT ]`\n\nMatch URLs which are IP address literals.\n\nExamples: \"127.0.1\", \"[0:0::1]\", \"[::1]\", \"http://[::1]:99\"\n* `IP_LITERAL \"/\" PREFIX_LENGTH_IN_BITS`\n\nMatch any URL that is to an IP literal that falls between the given range. IP range is specified using CIDR notation.\n\nExamples: \"192.168.1.1/16\", \"fefe:13::abc/33\".\n* `<local>`\n\nMatch local addresses. The meaning of `<local>` is whether the host matches one of: \"127.0.0.1\", \"::1\", \"localhost\".",
45073
46263
  "slug": "proxy-config",
45074
46264
  "websiteUrl": "https://electronjs.org/docs/api/structures/proxy-config",
45075
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/proxy-config.md",
45076
- "version": "31.7.7",
46265
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/proxy-config.md",
46266
+ "version": "34.3.0",
45077
46267
  "properties": [
45078
46268
  {
45079
46269
  "name": "mode",
@@ -45140,8 +46330,8 @@
45140
46330
  "description": "",
45141
46331
  "slug": "rectangle",
45142
46332
  "websiteUrl": "https://electronjs.org/docs/api/structures/rectangle",
45143
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/rectangle.md",
45144
- "version": "31.7.7",
46333
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/rectangle.md",
46334
+ "version": "34.3.0",
45145
46335
  "properties": [
45146
46336
  {
45147
46337
  "name": "x",
@@ -45183,8 +46373,8 @@
45183
46373
  "description": "",
45184
46374
  "slug": "referrer",
45185
46375
  "websiteUrl": "https://electronjs.org/docs/api/structures/referrer",
45186
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/referrer.md",
45187
- "version": "31.7.7",
46376
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/referrer.md",
46377
+ "version": "34.3.0",
45188
46378
  "properties": [
45189
46379
  {
45190
46380
  "name": "url",
@@ -45245,8 +46435,8 @@
45245
46435
  "description": "",
45246
46436
  "slug": "render-process-gone-details",
45247
46437
  "websiteUrl": "https://electronjs.org/docs/api/structures/render-process-gone-details",
45248
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/render-process-gone-details.md",
45249
- "version": "31.7.7",
46438
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/render-process-gone-details.md",
46439
+ "version": "34.3.0",
45250
46440
  "properties": [
45251
46441
  {
45252
46442
  "name": "reason",
@@ -45302,8 +46492,8 @@
45302
46492
  "description": "",
45303
46493
  "slug": "resolved-endpoint",
45304
46494
  "websiteUrl": "https://electronjs.org/docs/api/structures/resolved-endpoint",
45305
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/resolved-endpoint.md",
45306
- "version": "31.7.7",
46495
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/resolved-endpoint.md",
46496
+ "version": "34.3.0",
45307
46497
  "properties": [
45308
46498
  {
45309
46499
  "name": "address",
@@ -45344,8 +46534,8 @@
45344
46534
  "description": "",
45345
46535
  "slug": "resolved-host",
45346
46536
  "websiteUrl": "https://electronjs.org/docs/api/structures/resolved-host",
45347
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/resolved-host.md",
45348
- "version": "31.7.7",
46537
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/resolved-host.md",
46538
+ "version": "34.3.0",
45349
46539
  "properties": [
45350
46540
  {
45351
46541
  "name": "endpoints",
@@ -45363,8 +46553,8 @@
45363
46553
  "description": "",
45364
46554
  "slug": "scrubber-item",
45365
46555
  "websiteUrl": "https://electronjs.org/docs/api/structures/scrubber-item",
45366
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/scrubber-item.md",
45367
- "version": "31.7.7",
46556
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/scrubber-item.md",
46557
+ "version": "34.3.0",
45368
46558
  "properties": [
45369
46559
  {
45370
46560
  "name": "label",
@@ -45391,8 +46581,8 @@
45391
46581
  "description": "",
45392
46582
  "slug": "segmented-control-segment",
45393
46583
  "websiteUrl": "https://electronjs.org/docs/api/structures/segmented-control-segment",
45394
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/segmented-control-segment.md",
45395
- "version": "31.7.7",
46584
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/segmented-control-segment.md",
46585
+ "version": "34.3.0",
45396
46586
  "properties": [
45397
46587
  {
45398
46588
  "name": "label",
@@ -45427,8 +46617,8 @@
45427
46617
  "description": "",
45428
46618
  "slug": "serial-port",
45429
46619
  "websiteUrl": "https://electronjs.org/docs/api/structures/serial-port",
45430
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/serial-port.md",
45431
- "version": "31.7.7",
46620
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/serial-port.md",
46621
+ "version": "34.3.0",
45432
46622
  "properties": [
45433
46623
  {
45434
46624
  "name": "portId",
@@ -45514,8 +46704,8 @@
45514
46704
  "description": "",
45515
46705
  "slug": "service-worker-info",
45516
46706
  "websiteUrl": "https://electronjs.org/docs/api/structures/service-worker-info",
45517
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/service-worker-info.md",
45518
- "version": "31.7.7",
46707
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/service-worker-info.md",
46708
+ "version": "34.3.0",
45519
46709
  "properties": [
45520
46710
  {
45521
46711
  "name": "scriptUrl",
@@ -45545,14 +46735,147 @@
45545
46735
  }
45546
46736
  ]
45547
46737
  },
46738
+ {
46739
+ "type": "Structure",
46740
+ "name": "SharedDictionaryInfo",
46741
+ "description": "",
46742
+ "slug": "shared-dictionary-info",
46743
+ "websiteUrl": "https://electronjs.org/docs/api/structures/shared-dictionary-info",
46744
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/shared-dictionary-info.md",
46745
+ "version": "34.3.0",
46746
+ "properties": [
46747
+ {
46748
+ "name": "match",
46749
+ "description": "The matching path pattern for the dictionary which was declared in 'use-as-dictionary' response header's `match` option.",
46750
+ "required": true,
46751
+ "additionalTags": [],
46752
+ "collection": false,
46753
+ "type": "String",
46754
+ "possibleValues": null
46755
+ },
46756
+ {
46757
+ "name": "matchDestinations",
46758
+ "description": "An array of matching destinations for the dictionary which was declared in 'use-as-dictionary' response header's `match-dest` option.",
46759
+ "required": true,
46760
+ "additionalTags": [],
46761
+ "collection": true,
46762
+ "type": "String",
46763
+ "possibleValues": null
46764
+ },
46765
+ {
46766
+ "name": "id",
46767
+ "description": "The Id for the dictionary which was declared in 'use-as-dictionary' response header's `id` option.",
46768
+ "required": true,
46769
+ "additionalTags": [],
46770
+ "collection": false,
46771
+ "type": "String",
46772
+ "possibleValues": null
46773
+ },
46774
+ {
46775
+ "name": "dictionaryUrl",
46776
+ "description": "URL of the dictionary.",
46777
+ "required": true,
46778
+ "additionalTags": [],
46779
+ "collection": false,
46780
+ "type": "String",
46781
+ "possibleValues": null
46782
+ },
46783
+ {
46784
+ "name": "lastFetchTime",
46785
+ "description": "The time of when the dictionary was received from the network layer.",
46786
+ "required": true,
46787
+ "additionalTags": [],
46788
+ "collection": false,
46789
+ "type": "Date"
46790
+ },
46791
+ {
46792
+ "name": "responseTime",
46793
+ "description": "The time of when the dictionary was received from the server. For cached responses, this time could be \"far\" in the past.",
46794
+ "required": true,
46795
+ "additionalTags": [],
46796
+ "collection": false,
46797
+ "type": "Date"
46798
+ },
46799
+ {
46800
+ "name": "expirationDuration",
46801
+ "description": "The expiration time for the dictionary which was declared in 'use-as-dictionary' response header's `expires` option in seconds.",
46802
+ "required": true,
46803
+ "additionalTags": [],
46804
+ "collection": false,
46805
+ "type": "number"
46806
+ },
46807
+ {
46808
+ "name": "lastUsedTime",
46809
+ "description": "The time when the dictionary was last used.",
46810
+ "required": true,
46811
+ "additionalTags": [],
46812
+ "collection": false,
46813
+ "type": "Date"
46814
+ },
46815
+ {
46816
+ "name": "size",
46817
+ "description": "The amount of bytes stored for this shared dictionary information object in Chromium's internal storage (usually Sqlite).",
46818
+ "required": true,
46819
+ "additionalTags": [],
46820
+ "collection": false,
46821
+ "type": "number"
46822
+ },
46823
+ {
46824
+ "name": "hash",
46825
+ "description": "The sha256 hash of the dictionary binary.",
46826
+ "required": true,
46827
+ "additionalTags": [],
46828
+ "collection": false,
46829
+ "type": "String",
46830
+ "possibleValues": null
46831
+ }
46832
+ ]
46833
+ },
46834
+ {
46835
+ "type": "Structure",
46836
+ "name": "SharedDictionaryUsageInfo",
46837
+ "description": "",
46838
+ "slug": "shared-dictionary-usage-info",
46839
+ "websiteUrl": "https://electronjs.org/docs/api/structures/shared-dictionary-usage-info",
46840
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/shared-dictionary-usage-info.md",
46841
+ "version": "34.3.0",
46842
+ "properties": [
46843
+ {
46844
+ "name": "frameOrigin",
46845
+ "description": "The origin of the frame where the request originates. It’s specific to the individual frame making the request and is defined by its scheme, host, and port. In practice, will look like a URL.",
46846
+ "required": true,
46847
+ "additionalTags": [],
46848
+ "collection": false,
46849
+ "type": "String",
46850
+ "possibleValues": null
46851
+ },
46852
+ {
46853
+ "name": "topFrameSite",
46854
+ "description": "The site of the top-level browsing context (the main frame or tab that contains the request). It’s less granular than `frameOrigin` and focuses on the broader \"site\" scope. In practice, will look like a URL.",
46855
+ "required": true,
46856
+ "additionalTags": [],
46857
+ "collection": false,
46858
+ "type": "String",
46859
+ "possibleValues": null
46860
+ },
46861
+ {
46862
+ "name": "totalSizeBytes",
46863
+ "description": "The amount of bytes stored for this shared dictionary information object in Chromium's internal storage (usually Sqlite).",
46864
+ "required": true,
46865
+ "additionalTags": [],
46866
+ "collection": false,
46867
+ "type": "number"
46868
+ }
46869
+ ]
46870
+ },
45548
46871
  {
45549
46872
  "type": "Structure",
45550
46873
  "name": "SharedWorkerInfo",
45551
46874
  "description": "",
45552
46875
  "slug": "shared-worker-info",
45553
46876
  "websiteUrl": "https://electronjs.org/docs/api/structures/shared-worker-info",
45554
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/shared-worker-info.md",
45555
- "version": "31.7.7",
46877
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/shared-worker-info.md",
46878
+ "version": "34.3.0",
45556
46879
  "properties": [
45557
46880
  {
45558
46881
  "name": "id",
@@ -45580,8 +46903,8 @@
45580
46903
  "description": "",
45581
46904
  "slug": "sharing-item",
45582
46905
  "websiteUrl": "https://electronjs.org/docs/api/structures/sharing-item",
45583
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/sharing-item.md",
45584
- "version": "31.7.7",
46906
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/sharing-item.md",
46907
+ "version": "34.3.0",
45585
46908
  "properties": [
45586
46909
  {
45587
46910
  "name": "texts",
@@ -45618,8 +46941,8 @@
45618
46941
  "description": "",
45619
46942
  "slug": "shortcut-details",
45620
46943
  "websiteUrl": "https://electronjs.org/docs/api/structures/shortcut-details",
45621
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/shortcut-details.md",
45622
- "version": "31.7.7",
46944
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/shortcut-details.md",
46945
+ "version": "34.3.0",
45623
46946
  "properties": [
45624
46947
  {
45625
46948
  "name": "target",
@@ -45700,8 +47023,8 @@
45700
47023
  "description": "",
45701
47024
  "slug": "size",
45702
47025
  "websiteUrl": "https://electronjs.org/docs/api/structures/size",
45703
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/size.md",
45704
- "version": "31.7.7",
47026
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/size.md",
47027
+ "version": "34.3.0",
45705
47028
  "properties": [
45706
47029
  {
45707
47030
  "name": "width",
@@ -45727,8 +47050,8 @@
45727
47050
  "description": "",
45728
47051
  "slug": "task",
45729
47052
  "websiteUrl": "https://electronjs.org/docs/api/structures/task",
45730
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/task.md",
45731
- "version": "31.7.7",
47053
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/task.md",
47054
+ "version": "34.3.0",
45732
47055
  "properties": [
45733
47056
  {
45734
47057
  "name": "program",
@@ -45800,8 +47123,8 @@
45800
47123
  "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.",
45801
47124
  "slug": "thumbar-button",
45802
47125
  "websiteUrl": "https://electronjs.org/docs/api/structures/thumbar-button",
45803
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/thumbar-button.md",
45804
- "version": "31.7.7",
47126
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/thumbar-button.md",
47127
+ "version": "34.3.0",
45805
47128
  "properties": [
45806
47129
  {
45807
47130
  "name": "icon",
@@ -45847,8 +47170,8 @@
45847
47170
  "description": "",
45848
47171
  "slug": "trace-categories-and-options",
45849
47172
  "websiteUrl": "https://electronjs.org/docs/api/structures/trace-categories-and-options",
45850
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/trace-categories-and-options.md",
45851
- "version": "31.7.7",
47173
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/trace-categories-and-options.md",
47174
+ "version": "34.3.0",
45852
47175
  "properties": [
45853
47176
  {
45854
47177
  "name": "categoryFilter",
@@ -45876,8 +47199,8 @@
45876
47199
  "description": "An example TraceConfig that roughly matches what Chrome DevTools records:",
45877
47200
  "slug": "trace-config",
45878
47201
  "websiteUrl": "https://electronjs.org/docs/api/structures/trace-config",
45879
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/trace-config.md",
45880
- "version": "31.7.7",
47202
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/trace-config.md",
47203
+ "version": "34.3.0",
45881
47204
  "properties": [
45882
47205
  {
45883
47206
  "name": "recording_mode",
@@ -45991,8 +47314,8 @@
45991
47314
  "description": "",
45992
47315
  "slug": "transaction",
45993
47316
  "websiteUrl": "https://electronjs.org/docs/api/structures/transaction",
45994
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/transaction.md",
45995
- "version": "31.7.7",
47317
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/transaction.md",
47318
+ "version": "34.3.0",
45996
47319
  "properties": [
45997
47320
  {
45998
47321
  "name": "transactionIdentifier",
@@ -46120,8 +47443,8 @@
46120
47443
  "description": "",
46121
47444
  "slug": "upload-data",
46122
47445
  "websiteUrl": "https://electronjs.org/docs/api/structures/upload-data",
46123
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/upload-data.md",
46124
- "version": "31.7.7",
47446
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/upload-data.md",
47447
+ "version": "34.3.0",
46125
47448
  "properties": [
46126
47449
  {
46127
47450
  "name": "bytes",
@@ -46157,8 +47480,8 @@
46157
47480
  "description": "",
46158
47481
  "slug": "upload-file",
46159
47482
  "websiteUrl": "https://electronjs.org/docs/api/structures/upload-file",
46160
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/upload-file.md",
46161
- "version": "31.7.7",
47483
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/upload-file.md",
47484
+ "version": "34.3.0",
46162
47485
  "properties": [
46163
47486
  {
46164
47487
  "name": "type",
@@ -46209,8 +47532,8 @@
46209
47532
  "description": "",
46210
47533
  "slug": "upload-raw-data",
46211
47534
  "websiteUrl": "https://electronjs.org/docs/api/structures/upload-raw-data",
46212
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/upload-raw-data.md",
46213
- "version": "31.7.7",
47535
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/upload-raw-data.md",
47536
+ "version": "34.3.0",
46214
47537
  "properties": [
46215
47538
  {
46216
47539
  "name": "type",
@@ -46236,8 +47559,8 @@
46236
47559
  "description": "",
46237
47560
  "slug": "usb-device",
46238
47561
  "websiteUrl": "https://electronjs.org/docs/api/structures/usb-device",
46239
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/usb-device.md",
46240
- "version": "31.7.7",
47562
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/usb-device.md",
47563
+ "version": "34.3.0",
46241
47564
  "properties": [
46242
47565
  {
46243
47566
  "name": "deviceId",
@@ -46371,8 +47694,8 @@
46371
47694
  "description": "This type is a helper alias, no object will ever exist of this type.",
46372
47695
  "slug": "user-default-types",
46373
47696
  "websiteUrl": "https://electronjs.org/docs/api/structures/user-default-types",
46374
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/user-default-types.md",
46375
- "version": "31.7.7",
47697
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/user-default-types.md",
47698
+ "version": "34.3.0",
46376
47699
  "properties": [
46377
47700
  {
46378
47701
  "name": "string",
@@ -46465,8 +47788,8 @@
46465
47788
  "description": "",
46466
47789
  "slug": "web-preferences",
46467
47790
  "websiteUrl": "https://electronjs.org/docs/api/structures/web-preferences",
46468
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/web-preferences.md",
46469
- "version": "31.7.7",
47791
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/web-preferences.md",
47792
+ "version": "34.3.0",
46470
47793
  "properties": [
46471
47794
  {
46472
47795
  "name": "devTools",
@@ -46776,7 +48099,28 @@
46776
48099
  "required": false,
46777
48100
  "additionalTags": [],
46778
48101
  "collection": false,
46779
- "type": "boolean"
48102
+ "type": [
48103
+ {
48104
+ "collection": false,
48105
+ "type": "Object",
48106
+ "properties": [
48107
+ {
48108
+ "name": "useSharedTexture",
48109
+ "description": "Whether to use GPU shared texture for accelerated paint event. Defaults to `false`. See the offscreen rendering tutorial for more details.",
48110
+ "required": false,
48111
+ "additionalTags": [
48112
+ "stability_experimental"
48113
+ ],
48114
+ "collection": false,
48115
+ "type": "boolean"
48116
+ }
48117
+ ]
48118
+ },
48119
+ {
48120
+ "collection": false,
48121
+ "type": "boolean"
48122
+ }
48123
+ ]
46780
48124
  },
46781
48125
  {
46782
48126
  "name": "contextIsolation",
@@ -46932,6 +48276,16 @@
46932
48276
  "additionalTags": [],
46933
48277
  "collection": false,
46934
48278
  "type": "boolean"
48279
+ },
48280
+ {
48281
+ "name": "enableDeprecatedPaste",
48282
+ "description": "Whether to enable the `paste` execCommand. Default is `false`.",
48283
+ "required": false,
48284
+ "additionalTags": [
48285
+ "stability_deprecated"
48286
+ ],
48287
+ "collection": false,
48288
+ "type": "boolean"
46935
48289
  }
46936
48290
  ]
46937
48291
  },
@@ -46941,8 +48295,8 @@
46941
48295
  "description": "",
46942
48296
  "slug": "web-request-filter",
46943
48297
  "websiteUrl": "https://electronjs.org/docs/api/structures/web-request-filter",
46944
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/web-request-filter.md",
46945
- "version": "31.7.7",
48298
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/web-request-filter.md",
48299
+ "version": "34.3.0",
46946
48300
  "properties": [
46947
48301
  {
46948
48302
  "name": "urls",
@@ -47019,8 +48373,8 @@
47019
48373
  "description": "",
47020
48374
  "slug": "web-source",
47021
48375
  "websiteUrl": "https://electronjs.org/docs/api/structures/web-source",
47022
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/web-source.md",
47023
- "version": "31.7.7",
48376
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/web-source.md",
48377
+ "version": "34.3.0",
47024
48378
  "properties": [
47025
48379
  {
47026
48380
  "name": "code",
@@ -47048,8 +48402,8 @@
47048
48402
  "description": "",
47049
48403
  "slug": "window-open-handler-response",
47050
48404
  "websiteUrl": "https://electronjs.org/docs/api/structures/window-open-handler-response",
47051
- "repoUrl": "https://github.com/electron/electron/blob/v31.7.7/docs/api/structures/window-open-handler-response.md",
47052
- "version": "31.7.7",
48405
+ "repoUrl": "https://github.com/electron/electron/blob/v34.3.0/docs/api/structures/window-open-handler-response.md",
48406
+ "version": "34.3.0",
47053
48407
  "properties": [
47054
48408
  {
47055
48409
  "name": "action",