electron-types 45.0.0-alpha.9 → 45.0.0-beta.2
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/README.md +3 -3
- package/dist/electron.d.ts +212 -34
- package/dist/version.json +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -14,11 +14,11 @@ The official `electron` package is ~200MB because it includes the Electron binar
|
|
|
14
14
|
Since this package only provides TypeScript types, install it as a dev dependency. **Install the version that matches your Electron version** (see [Version Matching](#version-matching)):
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
|
-
npm install -D electron-types@45.0.0-
|
|
17
|
+
npm install -D electron-types@45.0.0-beta.2
|
|
18
18
|
# or
|
|
19
|
-
yarn add -D electron-types@45.0.0-
|
|
19
|
+
yarn add -D electron-types@45.0.0-beta.2
|
|
20
20
|
# or
|
|
21
|
-
pnpm add -D electron-types@45.0.0-
|
|
21
|
+
pnpm add -D electron-types@45.0.0-beta.2
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
## Usage
|
package/dist/electron.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Type definitions for Electron 45.0.0-
|
|
1
|
+
// Type definitions for Electron 45.0.0-beta.2
|
|
2
2
|
// Project: http://electronjs.org/
|
|
3
3
|
// Definitions by: The Electron Team <https://github.com/electron/electron>
|
|
4
4
|
// Definitions: https://github.com/electron/typescript-definitions
|
|
@@ -300,7 +300,8 @@ declare namespace Electron {
|
|
|
300
300
|
isMainFrame: boolean) => void): this;
|
|
301
301
|
/**
|
|
302
302
|
* Emitted when the child process unexpectedly disappears. This is normally because
|
|
303
|
-
* it was crashed or killed. It does not include
|
|
303
|
+
* it was crashed or killed, or because it failed to launch. It does not include
|
|
304
|
+
* renderer processes.
|
|
304
305
|
*/
|
|
305
306
|
on(event: 'child-process-gone', listener: (event: Event,
|
|
306
307
|
details: Details) => void): this;
|
|
@@ -3017,6 +3018,10 @@ declare namespace Electron {
|
|
|
3017
3018
|
isContentProtected(): boolean;
|
|
3018
3019
|
/**
|
|
3019
3020
|
* Whether the window is destroyed.
|
|
3021
|
+
*
|
|
3022
|
+
* > [!NOTE] Once a window is destroyed, accessing most of its other properties and
|
|
3023
|
+
* methods throws `Object has been destroyed`, so callbacks that may run after the
|
|
3024
|
+
* window is gone should guard with `isDestroyed()`.
|
|
3020
3025
|
*/
|
|
3021
3026
|
isDestroyed(): boolean;
|
|
3022
3027
|
/**
|
|
@@ -3368,6 +3373,16 @@ declare namespace Electron {
|
|
|
3368
3373
|
* it calls SetWindowDisplayAffinity with `WDA_EXCLUDEFROMCAPTURE`. For Windows 10
|
|
3369
3374
|
* version 2004 and up the window will be removed from capture entirely, older
|
|
3370
3375
|
* Windows versions behave as if `WDA_MONITOR` is applied capturing a black window.
|
|
3376
|
+
* The change takes effect with the next desktop composition, not when the call
|
|
3377
|
+
* returns, so a capture started immediately afterwards can still contain the
|
|
3378
|
+
* window.
|
|
3379
|
+
*
|
|
3380
|
+
* Protection also applies in a Windows remote session. A Remote Desktop client
|
|
3381
|
+
* still shows the window to the remote user, but remote access software that works
|
|
3382
|
+
* by capturing the desktop cannot. To leave windows unprotected in remote sessions
|
|
3383
|
+
* instead, disable the `AllowWindowCaptureExclusionInRemoteSessions` Chromium
|
|
3384
|
+
* feature at the start of your main script. `win.isContentProtected()` still
|
|
3385
|
+
* returns `true` in that case.
|
|
3371
3386
|
*
|
|
3372
3387
|
* @platform darwin,win32
|
|
3373
3388
|
*/
|
|
@@ -3433,7 +3448,10 @@ declare namespace Electron {
|
|
|
3433
3448
|
* Makes the window ignore all mouse events.
|
|
3434
3449
|
*
|
|
3435
3450
|
* All mouse events happened in this window will be passed to the window below this
|
|
3436
|
-
* window, but if this window has focus, it will still receive keyboard events.
|
|
3451
|
+
* window, but if this window has focus, it will still receive keyboard events. On
|
|
3452
|
+
* Linux this is supported on both X11 and Wayland. On X11 the X server has applied
|
|
3453
|
+
* the window's new input shape when the call returns; on Wayland the new input
|
|
3454
|
+
* region is applied with the window's next frame.
|
|
3437
3455
|
*/
|
|
3438
3456
|
setIgnoreMouseEvents(ignore: boolean, options?: IgnoreMouseEventsOptions): void;
|
|
3439
3457
|
/**
|
|
@@ -6186,7 +6204,16 @@ declare namespace Electron {
|
|
|
6186
6204
|
* On Windows, it calls `SetWindowDisplayAffinity` with `WDA_EXCLUDEFROMCAPTURE`.
|
|
6187
6205
|
* For Windows 10 version 2004 and up the window will be removed from capture
|
|
6188
6206
|
* entirely, older Windows versions behave as if `WDA_MONITOR` is applied capturing
|
|
6189
|
-
* a black window.
|
|
6207
|
+
* a black window. The change takes effect with the next desktop composition, not
|
|
6208
|
+
* when the call returns, so a capture started immediately afterwards can still
|
|
6209
|
+
* contain the window.
|
|
6210
|
+
*
|
|
6211
|
+
* Protection also applies in a Windows remote session. A Remote Desktop client
|
|
6212
|
+
* still shows the window to the remote user, but remote access software that works
|
|
6213
|
+
* by capturing the desktop cannot. To leave windows unprotected in remote sessions
|
|
6214
|
+
* instead, disable the `AllowWindowCaptureExclusionInRemoteSessions` Chromium
|
|
6215
|
+
* feature at the start of your main script. `win.isContentProtected()` still
|
|
6216
|
+
* returns `true` in that case.
|
|
6190
6217
|
*
|
|
6191
6218
|
* On macOS, it sets the `NSWindow`'s `sharingType` to `NSWindowSharingNone`.
|
|
6192
6219
|
* Unfortunately, due to an intentional change in macOS, newer Mac applications
|
|
@@ -6256,7 +6283,10 @@ declare namespace Electron {
|
|
|
6256
6283
|
* Makes the window ignore all mouse events.
|
|
6257
6284
|
*
|
|
6258
6285
|
* All mouse events happened in this window will be passed to the window below this
|
|
6259
|
-
* window, but if this window has focus, it will still receive keyboard events.
|
|
6286
|
+
* window, but if this window has focus, it will still receive keyboard events. On
|
|
6287
|
+
* Linux this is supported on both X11 and Wayland. On X11 the X server has applied
|
|
6288
|
+
* the window's new input shape when the call returns; on Wayland the new input
|
|
6289
|
+
* region is applied with the window's next frame.
|
|
6260
6290
|
*/
|
|
6261
6291
|
setIgnoreMouseEvents(ignore: boolean, options?: IgnoreMouseEventsOptions): void;
|
|
6262
6292
|
/**
|
|
@@ -6718,6 +6748,9 @@ declare namespace Electron {
|
|
|
6718
6748
|
*
|
|
6719
6749
|
* See the `webContents` documentation for its methods and events.
|
|
6720
6750
|
*
|
|
6751
|
+
* > [!NOTE] Reading this property throws `Object has been destroyed` once the
|
|
6752
|
+
* window has been destroyed; see `win.isDestroyed()`.
|
|
6753
|
+
*
|
|
6721
6754
|
*/
|
|
6722
6755
|
readonly webContents: WebContents;
|
|
6723
6756
|
}
|
|
@@ -7114,7 +7147,7 @@ declare namespace Electron {
|
|
|
7114
7147
|
* resolves to a ClipboardBookmark object instead. Rejects when `type` is not
|
|
7115
7148
|
* present in `clipboardItem.types`.
|
|
7116
7149
|
*/
|
|
7117
|
-
getType(type:
|
|
7150
|
+
getType<T extends string>(type: T): Promise<string extends T ? (Blob | ClipboardBookmark) : T extends 'electron application/bookmark' ? ClipboardBookmark : Blob>;
|
|
7118
7151
|
/**
|
|
7119
7152
|
* Resolves with a ClipboardBookmark when a bookmark is available in the clipboard.
|
|
7120
7153
|
* Rejects when a bookmark is not available in the clipboard.
|
|
@@ -7463,7 +7496,9 @@ declare namespace Electron {
|
|
|
7463
7496
|
/**
|
|
7464
7497
|
* Set an extra parameter to be sent with the crash report. The values specified
|
|
7465
7498
|
* here will be sent in addition to any values set via the `extra` option when
|
|
7466
|
-
* `start` was called.
|
|
7499
|
+
* `start` was called. Calling this again with the same key replaces the value. The
|
|
7500
|
+
* value is read when a crash happens, so you can update it as your app's state
|
|
7501
|
+
* changes.
|
|
7467
7502
|
*
|
|
7468
7503
|
* Parameters added in this fashion (or via the `extra` parameter to
|
|
7469
7504
|
* `crashReporter.start`) are specific to the calling process. Adding extra
|
|
@@ -7471,29 +7506,42 @@ declare namespace Electron {
|
|
|
7471
7506
|
* with crashes from renderer or other child processes. Similarly, adding extra
|
|
7472
7507
|
* parameters in a renderer process will not result in those parameters being sent
|
|
7473
7508
|
* with crashes that occur in other renderer processes or in the main process.
|
|
7509
|
+
* Processes created with `utilityProcess` have no API for setting extra
|
|
7510
|
+
* parameters, so only `globalExtra` values are sent with their crashes.
|
|
7474
7511
|
*
|
|
7475
7512
|
* > [!NOTE] Parameters have limits on the length of the keys and values. Key names
|
|
7476
7513
|
* must be no longer than 39 bytes, and values must be no longer than 20320 bytes.
|
|
7477
|
-
* Keys with names longer than the maximum
|
|
7478
|
-
* longer than the maximum length
|
|
7514
|
+
* Keys with names longer than the maximum are ignored, and a warning is emitted.
|
|
7515
|
+
* Values longer than the maximum length are truncated.
|
|
7479
7516
|
*/
|
|
7480
7517
|
addExtraParameter(key: string, value: string): void;
|
|
7481
7518
|
/**
|
|
7482
|
-
* The date and ID of the
|
|
7483
|
-
*
|
|
7484
|
-
*
|
|
7485
|
-
*
|
|
7519
|
+
* The date and ID of the crash report with the most recent upload time, from the
|
|
7520
|
+
* list returned by `getUploadedReports()`. If there are no crash reports at all,
|
|
7521
|
+
* `null` is returned.
|
|
7522
|
+
*
|
|
7523
|
+
* If no report has been uploaded yet but some are stored on disk, a report that
|
|
7524
|
+
* has not been uploaded may be returned. Check that its `id` is not empty before
|
|
7525
|
+
* treating it as uploaded.
|
|
7486
7526
|
*
|
|
7487
7527
|
* > [!NOTE] This method is only available in the main process.
|
|
7488
7528
|
*/
|
|
7489
7529
|
getLastCrashReport(): (CrashReport) | (null);
|
|
7490
7530
|
/**
|
|
7491
|
-
* The current 'extra' parameters of the crash reporter
|
|
7531
|
+
* The current 'extra' parameters of the crash reporter in the calling process, as
|
|
7532
|
+
* set with the `extra` option and `addExtraParameter`. Parameters set with the
|
|
7533
|
+
* `globalExtra` option are not included.
|
|
7492
7534
|
*/
|
|
7493
7535
|
getParameters(): Record<string, string>;
|
|
7494
7536
|
/**
|
|
7495
|
-
* Returns
|
|
7496
|
-
* ID.
|
|
7537
|
+
* Returns the crash reports stored on disk. Each report contains the date it was
|
|
7538
|
+
* uploaded and the ID that the crash server returned for it.
|
|
7539
|
+
*
|
|
7540
|
+
* Despite the method's name, reports that have not been uploaded (for example
|
|
7541
|
+
* because `uploadToServer` is `false`, the upload failed, or the report was rate
|
|
7542
|
+
* limited) are included too. For those reports, `id` is an empty string and `date`
|
|
7543
|
+
* is not meaningful. To list only uploaded reports, filter out reports with an
|
|
7544
|
+
* empty `id`.
|
|
7497
7545
|
*
|
|
7498
7546
|
* > [!NOTE] This method is only available in the main process.
|
|
7499
7547
|
*/
|
|
@@ -7536,9 +7584,9 @@ declare namespace Electron {
|
|
|
7536
7584
|
*
|
|
7537
7585
|
* > [!NOTE] Parameters passed in `extra`, `globalExtra` or set with
|
|
7538
7586
|
* `addExtraParameter` have limits on the length of the keys and values. Key names
|
|
7539
|
-
* must be at most 39 bytes long, and values must be no longer than
|
|
7540
|
-
* with names longer than the maximum
|
|
7541
|
-
* than the maximum length
|
|
7587
|
+
* must be at most 39 bytes long, and values must be no longer than 20320 bytes.
|
|
7588
|
+
* Keys with names longer than the maximum are ignored, and a warning is emitted.
|
|
7589
|
+
* Values longer than the maximum length are truncated.
|
|
7542
7590
|
*
|
|
7543
7591
|
* > [!NOTE] This method is only available in the main process.
|
|
7544
7592
|
*/
|
|
@@ -9754,6 +9802,10 @@ declare namespace Electron {
|
|
|
9754
9802
|
* Sets `menu` as the application menu on macOS. On Windows and Linux, the `menu`
|
|
9755
9803
|
* will be set as each window's top menu.
|
|
9756
9804
|
*
|
|
9805
|
+
* On Linux, the menu bar uses GTK theme colors when GTK is available. If GTK
|
|
9806
|
+
* cannot initialize, it uses Chromium's built-in light or dark menu colors,
|
|
9807
|
+
* following `nativeTheme.shouldUseDarkColors`.
|
|
9808
|
+
*
|
|
9757
9809
|
* Also on Windows and Linux, you can use a `&` in the top-level item name to
|
|
9758
9810
|
* indicate which letter should get a generated accelerator. For example, using
|
|
9759
9811
|
* `&File` for the file menu would result in a generated `Alt-F` accelerator that
|
|
@@ -11747,6 +11799,12 @@ declare namespace Electron {
|
|
|
11747
11799
|
|
|
11748
11800
|
// Docs: https://electronjs.org/docs/api/protocol
|
|
11749
11801
|
|
|
11802
|
+
/**
|
|
11803
|
+
* The source registered for `scheme` with `protocol.registerSource`, or `null`.
|
|
11804
|
+
*
|
|
11805
|
+
* @experimental
|
|
11806
|
+
*/
|
|
11807
|
+
getSource(scheme: string): (ProtocolSource) | (null);
|
|
11750
11808
|
/**
|
|
11751
11809
|
* Register a protocol handler for `scheme`. Requests made to URLs with this scheme
|
|
11752
11810
|
* will delegate to this handler to determine what response should be sent.
|
|
@@ -11810,7 +11868,7 @@ declare namespace Electron {
|
|
|
11810
11868
|
*/
|
|
11811
11869
|
interceptStringProtocol(scheme: string, handler: (request: ProtocolRequest, callback: (response: (string) | (ProtocolResponse)) => void) => void): boolean;
|
|
11812
11870
|
/**
|
|
11813
|
-
* Whether `scheme`
|
|
11871
|
+
* Whether `scheme` already has a handler or a source.
|
|
11814
11872
|
*/
|
|
11815
11873
|
isProtocolHandled(scheme: string): boolean;
|
|
11816
11874
|
/**
|
|
@@ -11905,6 +11963,28 @@ declare namespace Electron {
|
|
|
11905
11963
|
* correctly expect streaming responses.
|
|
11906
11964
|
*/
|
|
11907
11965
|
registerSchemesAsPrivileged(customSchemes: CustomScheme[]): void;
|
|
11966
|
+
/**
|
|
11967
|
+
* Serves `scheme` from directories on disk without a JavaScript handler. Each
|
|
11968
|
+
* request is matched against `routes` (a route with a `host` wins over one
|
|
11969
|
+
* without, then the longest `path` prefix wins), the rest of the URL's path is
|
|
11970
|
+
* resolved inside that route's `root`, and the file is streamed to the requester
|
|
11971
|
+
* the way `file:` URLs are, including from `asar` archives, with `Content-Type`
|
|
11972
|
+
* taken from the file extension. A path that resolves outside `root`, a missing
|
|
11973
|
+
* file, a request that matches no route, or a method other than `GET`/`HEAD` fails
|
|
11974
|
+
* with `net::ERR_FILE_NOT_FOUND`. A URL whose path ends in `/` serves the route's
|
|
11975
|
+
* `index` file.
|
|
11976
|
+
*
|
|
11977
|
+
* Use this instead of `protocol.handle` when a scheme only serves an app's own
|
|
11978
|
+
* bundled files: no request touches the main thread, so pages and their
|
|
11979
|
+
* subresources load at the same speed whether or not the main process is busy.
|
|
11980
|
+
*
|
|
11981
|
+
* A scheme has either a handler or a source; `protocol.unhandle` removes either,
|
|
11982
|
+
* and `protocol.isProtocolHandled` reports both. `webRequest` listeners apply to
|
|
11983
|
+
* these requests as to any other.
|
|
11984
|
+
*
|
|
11985
|
+
* @experimental
|
|
11986
|
+
*/
|
|
11987
|
+
registerSource(scheme: string, source: ProtocolSource): void;
|
|
11908
11988
|
/**
|
|
11909
11989
|
* Whether the protocol was successfully registered
|
|
11910
11990
|
*
|
|
@@ -11935,7 +12015,8 @@ declare namespace Electron {
|
|
|
11935
12015
|
*/
|
|
11936
12016
|
registerStringProtocol(scheme: string, handler: (request: ProtocolRequest, callback: (response: (string) | (ProtocolResponse)) => void) => void): boolean;
|
|
11937
12017
|
/**
|
|
11938
|
-
* Removes a protocol handler registered with `protocol.handle
|
|
12018
|
+
* Removes a protocol handler registered with `protocol.handle` or a source
|
|
12019
|
+
* registered with `protocol.registerSource`.
|
|
11939
12020
|
*/
|
|
11940
12021
|
unhandle(scheme: string): void;
|
|
11941
12022
|
/**
|
|
@@ -12052,6 +12133,32 @@ declare namespace Electron {
|
|
|
12052
12133
|
data: (string) | (Buffer);
|
|
12053
12134
|
}
|
|
12054
12135
|
|
|
12136
|
+
interface ProtocolRoute {
|
|
12137
|
+
|
|
12138
|
+
// Docs: https://electronjs.org/docs/api/structures/protocol-route
|
|
12139
|
+
|
|
12140
|
+
/**
|
|
12141
|
+
* Which URLs on the scheme this route serves. A route without `match` serves every
|
|
12142
|
+
* URL.
|
|
12143
|
+
*/
|
|
12144
|
+
match?: Match;
|
|
12145
|
+
/**
|
|
12146
|
+
* What the matched URLs are served from.
|
|
12147
|
+
*/
|
|
12148
|
+
source: Source;
|
|
12149
|
+
}
|
|
12150
|
+
|
|
12151
|
+
interface ProtocolSource {
|
|
12152
|
+
|
|
12153
|
+
// Docs: https://electronjs.org/docs/api/structures/protocol-source
|
|
12154
|
+
|
|
12155
|
+
/**
|
|
12156
|
+
* How URLs on the scheme map to directories on disk; see
|
|
12157
|
+
* `protocol.registerSource`.
|
|
12158
|
+
*/
|
|
12159
|
+
routes: ProtocolRoute[];
|
|
12160
|
+
}
|
|
12161
|
+
|
|
12055
12162
|
interface ProxyConfig {
|
|
12056
12163
|
|
|
12057
12164
|
// Docs: https://electronjs.org/docs/api/structures/proxy-config
|
|
@@ -13719,7 +13826,7 @@ declare namespace Electron {
|
|
|
13719
13826
|
*
|
|
13720
13827
|
* Passing `null` instead of a function resets the handler to its default state.
|
|
13721
13828
|
*/
|
|
13722
|
-
setDisplayMediaRequestHandler(handler: ((request: DisplayMediaRequestHandlerHandlerRequest, callback: (streams: Streams) => void) => void) | (null), opts?: DisplayMediaRequestHandlerOpts): void;
|
|
13829
|
+
setDisplayMediaRequestHandler(handler: ((request: DisplayMediaRequestHandlerHandlerRequest, callback: (streams: (Streams) | (null)) => void) => void) | (null), opts?: DisplayMediaRequestHandlerOpts): void;
|
|
13723
13830
|
/**
|
|
13724
13831
|
* Sets download saving directory. By default, the download directory will be the
|
|
13725
13832
|
* `Downloads` under the respective app folder.
|
|
@@ -18934,7 +19041,8 @@ declare namespace Electron {
|
|
|
18934
19041
|
*/
|
|
18935
19042
|
setUserAgent(userAgent: string): void;
|
|
18936
19043
|
/**
|
|
18937
|
-
* Sets the maximum and minimum pinch-to-zoom level.
|
|
19044
|
+
* Sets the maximum and minimum pinch-to-zoom level. The page keeps its normal
|
|
19045
|
+
* scale until the user pinches; a `minimumLevel` below 1 only allows zooming out.
|
|
18938
19046
|
*
|
|
18939
19047
|
* > [!NOTE] Visual zoom is disabled by default in Electron. To re-enable it, call:
|
|
18940
19048
|
*/
|
|
@@ -18966,14 +19074,15 @@ declare namespace Electron {
|
|
|
18966
19074
|
* Changes the zoom factor to the specified factor. Zoom factor is zoom percent
|
|
18967
19075
|
* divided by 100, so 300% = 3.0.
|
|
18968
19076
|
*
|
|
18969
|
-
* The factor must be greater than 0.0.
|
|
19077
|
+
* The factor must be greater than 0.0. Values outside the range Chromium can
|
|
19078
|
+
* display (0.25 to 5.0) are clamped to it.
|
|
18970
19079
|
*/
|
|
18971
19080
|
setZoomFactor(factor: number): void;
|
|
18972
19081
|
/**
|
|
18973
19082
|
* Changes the zoom level to the specified level. The original size is 0 and each
|
|
18974
|
-
* increment above or below represents zooming 20% larger or smaller
|
|
18975
|
-
*
|
|
18976
|
-
*
|
|
19083
|
+
* increment above or below represents zooming 20% larger or smaller. The formula
|
|
19084
|
+
* for this is `scale := 1.2 ^ level`, and the level is clamped to the range
|
|
19085
|
+
* Chromium can display (25% to 500%, about -7.6 to 8.8).
|
|
18977
19086
|
*
|
|
18978
19087
|
* > [!NOTE] The zoom policy at the Chromium level is same-origin by default,
|
|
18979
19088
|
* meaning that the zoom level for a specific domain propagates across all
|
|
@@ -21812,18 +21921,20 @@ declare namespace Electron {
|
|
|
21812
21921
|
uploadToServer?: boolean;
|
|
21813
21922
|
/**
|
|
21814
21923
|
* If true, crashes generated in the main process will not be forwarded to the
|
|
21815
|
-
* system crash handler. Default is `false`.
|
|
21924
|
+
* system crash handler. This option has no effect on Windows. Default is `false`.
|
|
21925
|
+
*
|
|
21926
|
+
* @platform darwin,linux
|
|
21816
21927
|
*/
|
|
21817
21928
|
ignoreSystemCrashHandler?: boolean;
|
|
21818
21929
|
/**
|
|
21819
|
-
* If true, limit the number of crashes uploaded to 1/hour.
|
|
21820
|
-
*
|
|
21821
|
-
* @platform darwin,win32
|
|
21930
|
+
* If true, limit the number of crashes uploaded to 1/hour. Crash reports over the
|
|
21931
|
+
* limit are not uploaded, but are still stored on disk. Default is `false`.
|
|
21822
21932
|
*/
|
|
21823
21933
|
rateLimit?: boolean;
|
|
21824
21934
|
/**
|
|
21825
21935
|
* If true, crash reports will be compressed and uploaded with `Content-Encoding:
|
|
21826
|
-
* gzip`.
|
|
21936
|
+
* gzip`. Setting this to `false` while `uploadToServer` is `true` is deprecated
|
|
21937
|
+
* and logs a deprecation warning. Default is `true`.
|
|
21827
21938
|
*/
|
|
21828
21939
|
compress?: boolean;
|
|
21829
21940
|
/**
|
|
@@ -21840,7 +21951,8 @@ declare namespace Electron {
|
|
|
21840
21951
|
* crash reporter has been started. If a key is present in both the global extra
|
|
21841
21952
|
* parameters and the process-specific extra parameters, then the global one will
|
|
21842
21953
|
* take precedence. By default, `productName` and the app version are included, as
|
|
21843
|
-
* well as the Electron version.
|
|
21954
|
+
* well as the Electron version. Global extra parameters are not returned by
|
|
21955
|
+
* `getParameters()`.
|
|
21844
21956
|
*/
|
|
21845
21957
|
globalExtra?: Record<string, string>;
|
|
21846
21958
|
}
|
|
@@ -21973,9 +22085,17 @@ declare namespace Electron {
|
|
|
21973
22085
|
reason: ('clean-exit' | 'abnormal-exit' | 'killed' | 'crashed' | 'oom' | 'launch-failed' | 'integrity-failure' | 'memory-eviction');
|
|
21974
22086
|
/**
|
|
21975
22087
|
* The exit code for the process (e.g. status from waitpid if on POSIX, from
|
|
21976
|
-
* GetExitCodeProcess on Windows)
|
|
22088
|
+
* GetExitCodeProcess on Windows), unless `reason` is `launch-failed`, in which
|
|
22089
|
+
* case `exitCode` will be a platform-specific launch failure error code.
|
|
21977
22090
|
*/
|
|
21978
22091
|
exitCode: number;
|
|
22092
|
+
/**
|
|
22093
|
+
* The Windows system error code (`GetLastError()`) of the failed launch. Only set
|
|
22094
|
+
* when `reason` is `launch-failed`.
|
|
22095
|
+
*
|
|
22096
|
+
* @platform win32
|
|
22097
|
+
*/
|
|
22098
|
+
systemErrorCode?: number;
|
|
21979
22099
|
/**
|
|
21980
22100
|
* The non-localized name of the process.
|
|
21981
22101
|
*/
|
|
@@ -22741,6 +22861,20 @@ declare namespace Electron {
|
|
|
22741
22861
|
args?: string[];
|
|
22742
22862
|
}
|
|
22743
22863
|
|
|
22864
|
+
interface Match {
|
|
22865
|
+
/**
|
|
22866
|
+
* Host name to match, for standard schemes. It is compared with the URL's host as
|
|
22867
|
+
* a whole, case-insensitively; there is no wildcard or subdomain matching. Omit to
|
|
22868
|
+
* match any host.
|
|
22869
|
+
*/
|
|
22870
|
+
host?: string;
|
|
22871
|
+
/**
|
|
22872
|
+
* Path prefix to match, starting with `/` and written as it appears in a URL
|
|
22873
|
+
* (percent-encoded). Defaults to `/`.
|
|
22874
|
+
*/
|
|
22875
|
+
path?: string;
|
|
22876
|
+
}
|
|
22877
|
+
|
|
22744
22878
|
interface MenuItemConstructorOptions {
|
|
22745
22879
|
/**
|
|
22746
22880
|
* Will be called with `click(menuItem, window, event)` when the menu item is
|
|
@@ -24279,6 +24413,30 @@ declare namespace Electron {
|
|
|
24279
24413
|
topFrameSite: string;
|
|
24280
24414
|
}
|
|
24281
24415
|
|
|
24416
|
+
interface Source {
|
|
24417
|
+
/**
|
|
24418
|
+
* Must be `directory`.
|
|
24419
|
+
*/
|
|
24420
|
+
type: string;
|
|
24421
|
+
/**
|
|
24422
|
+
* Absolute path of the directory. The part of the URL's path after `match.path` is
|
|
24423
|
+
* resolved inside it; paths that would leave it are not served. May point into an
|
|
24424
|
+
* `asar` archive.
|
|
24425
|
+
*/
|
|
24426
|
+
root: string;
|
|
24427
|
+
/**
|
|
24428
|
+
* File served for a URL whose path ends in `/`. Defaults to `index.html`; an empty
|
|
24429
|
+
* string disables it.
|
|
24430
|
+
*/
|
|
24431
|
+
index?: string;
|
|
24432
|
+
/**
|
|
24433
|
+
* Response headers added to every file served by this route. Headers computed by
|
|
24434
|
+
* the file loader, including `Content-Type`, `Content-Length`, and
|
|
24435
|
+
* `Content-Range`, will override these supplied values.
|
|
24436
|
+
*/
|
|
24437
|
+
headers?: Record<string, string>;
|
|
24438
|
+
}
|
|
24439
|
+
|
|
24282
24440
|
interface SourcesOptions {
|
|
24283
24441
|
/**
|
|
24284
24442
|
* An array of strings that lists the types of desktop sources to be captured,
|
|
@@ -25717,6 +25875,7 @@ declare namespace Electron {
|
|
|
25717
25875
|
type LoadURLOptions = Electron.LoadURLOptions;
|
|
25718
25876
|
type LoginItemSettings = Electron.LoginItemSettings;
|
|
25719
25877
|
type LoginItemSettingsOptions = Electron.LoginItemSettingsOptions;
|
|
25878
|
+
type Match = Electron.Match;
|
|
25720
25879
|
type MenuItemConstructorOptions = Electron.MenuItemConstructorOptions;
|
|
25721
25880
|
type MessageBoxOptions = Electron.MessageBoxOptions;
|
|
25722
25881
|
type MessageBoxReturnValue = Electron.MessageBoxReturnValue;
|
|
@@ -25783,6 +25942,7 @@ declare namespace Electron {
|
|
|
25783
25942
|
type SessionSelectWebauthnAuthenticatorEventParams = Electron.SessionSelectWebauthnAuthenticatorEventParams;
|
|
25784
25943
|
type Settings = Electron.Settings;
|
|
25785
25944
|
type SharedDictionaryInfoOptions = Electron.SharedDictionaryInfoOptions;
|
|
25945
|
+
type Source = Electron.Source;
|
|
25786
25946
|
type SourcesOptions = Electron.SourcesOptions;
|
|
25787
25947
|
type StartLoggingOptions = Electron.StartLoggingOptions;
|
|
25788
25948
|
type StartTask = Electron.StartTask;
|
|
@@ -25917,6 +26077,8 @@ declare namespace Electron {
|
|
|
25917
26077
|
type ProtocolRequest = Electron.ProtocolRequest;
|
|
25918
26078
|
type ProtocolResponse = Electron.ProtocolResponse;
|
|
25919
26079
|
type ProtocolResponseUploadData = Electron.ProtocolResponseUploadData;
|
|
26080
|
+
type ProtocolRoute = Electron.ProtocolRoute;
|
|
26081
|
+
type ProtocolSource = Electron.ProtocolSource;
|
|
25920
26082
|
type ProxyConfig = Electron.ProxyConfig;
|
|
25921
26083
|
type Rectangle = Electron.Rectangle;
|
|
25922
26084
|
type Referrer = Electron.Referrer;
|
|
@@ -26141,6 +26303,7 @@ declare namespace Electron {
|
|
|
26141
26303
|
type LoadURLOptions = Electron.LoadURLOptions;
|
|
26142
26304
|
type LoginItemSettings = Electron.LoginItemSettings;
|
|
26143
26305
|
type LoginItemSettingsOptions = Electron.LoginItemSettingsOptions;
|
|
26306
|
+
type Match = Electron.Match;
|
|
26144
26307
|
type MenuItemConstructorOptions = Electron.MenuItemConstructorOptions;
|
|
26145
26308
|
type MessageBoxOptions = Electron.MessageBoxOptions;
|
|
26146
26309
|
type MessageBoxReturnValue = Electron.MessageBoxReturnValue;
|
|
@@ -26207,6 +26370,7 @@ declare namespace Electron {
|
|
|
26207
26370
|
type SessionSelectWebauthnAuthenticatorEventParams = Electron.SessionSelectWebauthnAuthenticatorEventParams;
|
|
26208
26371
|
type Settings = Electron.Settings;
|
|
26209
26372
|
type SharedDictionaryInfoOptions = Electron.SharedDictionaryInfoOptions;
|
|
26373
|
+
type Source = Electron.Source;
|
|
26210
26374
|
type SourcesOptions = Electron.SourcesOptions;
|
|
26211
26375
|
type StartLoggingOptions = Electron.StartLoggingOptions;
|
|
26212
26376
|
type StartTask = Electron.StartTask;
|
|
@@ -26341,6 +26505,8 @@ declare namespace Electron {
|
|
|
26341
26505
|
type ProtocolRequest = Electron.ProtocolRequest;
|
|
26342
26506
|
type ProtocolResponse = Electron.ProtocolResponse;
|
|
26343
26507
|
type ProtocolResponseUploadData = Electron.ProtocolResponseUploadData;
|
|
26508
|
+
type ProtocolRoute = Electron.ProtocolRoute;
|
|
26509
|
+
type ProtocolSource = Electron.ProtocolSource;
|
|
26344
26510
|
type ProxyConfig = Electron.ProxyConfig;
|
|
26345
26511
|
type Rectangle = Electron.Rectangle;
|
|
26346
26512
|
type Referrer = Electron.Referrer;
|
|
@@ -26489,6 +26655,7 @@ declare namespace Electron {
|
|
|
26489
26655
|
type LoadURLOptions = Electron.LoadURLOptions;
|
|
26490
26656
|
type LoginItemSettings = Electron.LoginItemSettings;
|
|
26491
26657
|
type LoginItemSettingsOptions = Electron.LoginItemSettingsOptions;
|
|
26658
|
+
type Match = Electron.Match;
|
|
26492
26659
|
type MenuItemConstructorOptions = Electron.MenuItemConstructorOptions;
|
|
26493
26660
|
type MessageBoxOptions = Electron.MessageBoxOptions;
|
|
26494
26661
|
type MessageBoxReturnValue = Electron.MessageBoxReturnValue;
|
|
@@ -26555,6 +26722,7 @@ declare namespace Electron {
|
|
|
26555
26722
|
type SessionSelectWebauthnAuthenticatorEventParams = Electron.SessionSelectWebauthnAuthenticatorEventParams;
|
|
26556
26723
|
type Settings = Electron.Settings;
|
|
26557
26724
|
type SharedDictionaryInfoOptions = Electron.SharedDictionaryInfoOptions;
|
|
26725
|
+
type Source = Electron.Source;
|
|
26558
26726
|
type SourcesOptions = Electron.SourcesOptions;
|
|
26559
26727
|
type StartLoggingOptions = Electron.StartLoggingOptions;
|
|
26560
26728
|
type StartTask = Electron.StartTask;
|
|
@@ -26689,6 +26857,8 @@ declare namespace Electron {
|
|
|
26689
26857
|
type ProtocolRequest = Electron.ProtocolRequest;
|
|
26690
26858
|
type ProtocolResponse = Electron.ProtocolResponse;
|
|
26691
26859
|
type ProtocolResponseUploadData = Electron.ProtocolResponseUploadData;
|
|
26860
|
+
type ProtocolRoute = Electron.ProtocolRoute;
|
|
26861
|
+
type ProtocolSource = Electron.ProtocolSource;
|
|
26692
26862
|
type ProxyConfig = Electron.ProxyConfig;
|
|
26693
26863
|
type Rectangle = Electron.Rectangle;
|
|
26694
26864
|
type Referrer = Electron.Referrer;
|
|
@@ -26839,6 +27009,7 @@ declare namespace Electron {
|
|
|
26839
27009
|
type LoadURLOptions = Electron.LoadURLOptions;
|
|
26840
27010
|
type LoginItemSettings = Electron.LoginItemSettings;
|
|
26841
27011
|
type LoginItemSettingsOptions = Electron.LoginItemSettingsOptions;
|
|
27012
|
+
type Match = Electron.Match;
|
|
26842
27013
|
type MenuItemConstructorOptions = Electron.MenuItemConstructorOptions;
|
|
26843
27014
|
type MessageBoxOptions = Electron.MessageBoxOptions;
|
|
26844
27015
|
type MessageBoxReturnValue = Electron.MessageBoxReturnValue;
|
|
@@ -26905,6 +27076,7 @@ declare namespace Electron {
|
|
|
26905
27076
|
type SessionSelectWebauthnAuthenticatorEventParams = Electron.SessionSelectWebauthnAuthenticatorEventParams;
|
|
26906
27077
|
type Settings = Electron.Settings;
|
|
26907
27078
|
type SharedDictionaryInfoOptions = Electron.SharedDictionaryInfoOptions;
|
|
27079
|
+
type Source = Electron.Source;
|
|
26908
27080
|
type SourcesOptions = Electron.SourcesOptions;
|
|
26909
27081
|
type StartLoggingOptions = Electron.StartLoggingOptions;
|
|
26910
27082
|
type StartTask = Electron.StartTask;
|
|
@@ -27039,6 +27211,8 @@ declare namespace Electron {
|
|
|
27039
27211
|
type ProtocolRequest = Electron.ProtocolRequest;
|
|
27040
27212
|
type ProtocolResponse = Electron.ProtocolResponse;
|
|
27041
27213
|
type ProtocolResponseUploadData = Electron.ProtocolResponseUploadData;
|
|
27214
|
+
type ProtocolRoute = Electron.ProtocolRoute;
|
|
27215
|
+
type ProtocolSource = Electron.ProtocolSource;
|
|
27042
27216
|
type ProxyConfig = Electron.ProxyConfig;
|
|
27043
27217
|
type Rectangle = Electron.Rectangle;
|
|
27044
27218
|
type Referrer = Electron.Referrer;
|
|
@@ -27285,6 +27459,7 @@ declare namespace Electron {
|
|
|
27285
27459
|
type LoadURLOptions = Electron.LoadURLOptions;
|
|
27286
27460
|
type LoginItemSettings = Electron.LoginItemSettings;
|
|
27287
27461
|
type LoginItemSettingsOptions = Electron.LoginItemSettingsOptions;
|
|
27462
|
+
type Match = Electron.Match;
|
|
27288
27463
|
type MenuItemConstructorOptions = Electron.MenuItemConstructorOptions;
|
|
27289
27464
|
type MessageBoxOptions = Electron.MessageBoxOptions;
|
|
27290
27465
|
type MessageBoxReturnValue = Electron.MessageBoxReturnValue;
|
|
@@ -27351,6 +27526,7 @@ declare namespace Electron {
|
|
|
27351
27526
|
type SessionSelectWebauthnAuthenticatorEventParams = Electron.SessionSelectWebauthnAuthenticatorEventParams;
|
|
27352
27527
|
type Settings = Electron.Settings;
|
|
27353
27528
|
type SharedDictionaryInfoOptions = Electron.SharedDictionaryInfoOptions;
|
|
27529
|
+
type Source = Electron.Source;
|
|
27354
27530
|
type SourcesOptions = Electron.SourcesOptions;
|
|
27355
27531
|
type StartLoggingOptions = Electron.StartLoggingOptions;
|
|
27356
27532
|
type StartTask = Electron.StartTask;
|
|
@@ -27485,6 +27661,8 @@ declare namespace Electron {
|
|
|
27485
27661
|
type ProtocolRequest = Electron.ProtocolRequest;
|
|
27486
27662
|
type ProtocolResponse = Electron.ProtocolResponse;
|
|
27487
27663
|
type ProtocolResponseUploadData = Electron.ProtocolResponseUploadData;
|
|
27664
|
+
type ProtocolRoute = Electron.ProtocolRoute;
|
|
27665
|
+
type ProtocolSource = Electron.ProtocolSource;
|
|
27488
27666
|
type ProxyConfig = Electron.ProxyConfig;
|
|
27489
27667
|
type Rectangle = Electron.Rectangle;
|
|
27490
27668
|
type Referrer = Electron.Referrer;
|
package/dist/version.json
CHANGED