electron-types 44.0.0-alpha.6 → 44.0.0-alpha.7
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 +48 -32
- 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@44.0.0-alpha.
|
|
17
|
+
npm install -D electron-types@44.0.0-alpha.7
|
|
18
18
|
# or
|
|
19
|
-
yarn add -D electron-types@44.0.0-alpha.
|
|
19
|
+
yarn add -D electron-types@44.0.0-alpha.7
|
|
20
20
|
# or
|
|
21
|
-
pnpm add -D electron-types@44.0.0-alpha.
|
|
21
|
+
pnpm add -D electron-types@44.0.0-alpha.7
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
## Usage
|
package/dist/electron.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Type definitions for Electron 44.0.0-alpha.
|
|
1
|
+
// Type definitions for Electron 44.0.0-alpha.7
|
|
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
|
|
@@ -50,7 +50,7 @@ declare namespace Electron {
|
|
|
50
50
|
// Docs: https://electronjs.org/docs/api/app
|
|
51
51
|
|
|
52
52
|
/**
|
|
53
|
-
* Emitted when
|
|
53
|
+
* Emitted when Chromium's accessibility support changes. This event fires when
|
|
54
54
|
* assistive technologies, such as screen readers, are enabled or disabled. See
|
|
55
55
|
* https://www.chromium.org/developers/design-documents/accessibility for more
|
|
56
56
|
* details.
|
|
@@ -59,7 +59,7 @@ declare namespace Electron {
|
|
|
59
59
|
*/
|
|
60
60
|
on(event: 'accessibility-support-changed', listener: (event: Event,
|
|
61
61
|
/**
|
|
62
|
-
* `true` when
|
|
62
|
+
* `true` when Chromium's accessibility support is enabled, `false` otherwise.
|
|
63
63
|
*/
|
|
64
64
|
accessibilitySupportEnabled: boolean) => void): this;
|
|
65
65
|
/**
|
|
@@ -67,7 +67,7 @@ declare namespace Electron {
|
|
|
67
67
|
*/
|
|
68
68
|
off(event: 'accessibility-support-changed', listener: (event: Event,
|
|
69
69
|
/**
|
|
70
|
-
* `true` when
|
|
70
|
+
* `true` when Chromium's accessibility support is enabled, `false` otherwise.
|
|
71
71
|
*/
|
|
72
72
|
accessibilitySupportEnabled: boolean) => void): this;
|
|
73
73
|
/**
|
|
@@ -75,7 +75,7 @@ declare namespace Electron {
|
|
|
75
75
|
*/
|
|
76
76
|
once(event: 'accessibility-support-changed', listener: (event: Event,
|
|
77
77
|
/**
|
|
78
|
-
* `true` when
|
|
78
|
+
* `true` when Chromium's accessibility support is enabled, `false` otherwise.
|
|
79
79
|
*/
|
|
80
80
|
accessibilitySupportEnabled: boolean) => void): this;
|
|
81
81
|
/**
|
|
@@ -83,7 +83,7 @@ declare namespace Electron {
|
|
|
83
83
|
*/
|
|
84
84
|
addListener(event: 'accessibility-support-changed', listener: (event: Event,
|
|
85
85
|
/**
|
|
86
|
-
* `true` when
|
|
86
|
+
* `true` when Chromium's accessibility support is enabled, `false` otherwise.
|
|
87
87
|
*/
|
|
88
88
|
accessibilitySupportEnabled: boolean) => void): this;
|
|
89
89
|
/**
|
|
@@ -91,7 +91,7 @@ declare namespace Electron {
|
|
|
91
91
|
*/
|
|
92
92
|
removeListener(event: 'accessibility-support-changed', listener: (event: Event,
|
|
93
93
|
/**
|
|
94
|
-
* `true` when
|
|
94
|
+
* `true` when Chromium's accessibility support is enabled, `false` otherwise.
|
|
95
95
|
*/
|
|
96
96
|
accessibilitySupportEnabled: boolean) => void): this;
|
|
97
97
|
/**
|
|
@@ -1403,9 +1403,9 @@ declare namespace Electron {
|
|
|
1403
1403
|
*/
|
|
1404
1404
|
invalidateCurrentActivity(): void;
|
|
1405
1405
|
/**
|
|
1406
|
-
* `true` if
|
|
1407
|
-
* will return `true` if the use of assistive technologies, such as screen
|
|
1408
|
-
* has been detected. See
|
|
1406
|
+
* `true` if Chromium's accessibility support is enabled, `false` otherwise. This
|
|
1407
|
+
* API will return `true` if the use of assistive technologies, such as screen
|
|
1408
|
+
* readers, has been detected. See
|
|
1409
1409
|
* https://www.chromium.org/developers/design-documents/accessibility for more
|
|
1410
1410
|
* details.
|
|
1411
1411
|
*
|
|
@@ -1590,7 +1590,7 @@ declare namespace Electron {
|
|
|
1590
1590
|
*/
|
|
1591
1591
|
setAboutPanelOptions(options: AboutPanelOptionsOptions): void;
|
|
1592
1592
|
/**
|
|
1593
|
-
* Manually enables
|
|
1593
|
+
* Manually enables Chromium's accessibility support, allowing to expose
|
|
1594
1594
|
* accessibility switch to users in application settings. See Chromium's
|
|
1595
1595
|
* accessibility docs for more details. Disabled by default.
|
|
1596
1596
|
*
|
|
@@ -1894,10 +1894,10 @@ declare namespace Electron {
|
|
|
1894
1894
|
*/
|
|
1895
1895
|
whenReady(): Promise<void>;
|
|
1896
1896
|
/**
|
|
1897
|
-
* A `boolean` property that's `true` if
|
|
1898
|
-
* `false` otherwise. This property will be `true` if the use of assistive
|
|
1897
|
+
* A `boolean` property that's `true` if Chromium's accessibility support is
|
|
1898
|
+
* enabled, `false` otherwise. This property will be `true` if the use of assistive
|
|
1899
1899
|
* technologies, such as screen readers, has been detected. Setting this property
|
|
1900
|
-
* to `true` manually enables
|
|
1900
|
+
* to `true` manually enables Chromium's accessibility support, allowing developers
|
|
1901
1901
|
* to expose accessibility switch to users in application settings.
|
|
1902
1902
|
*
|
|
1903
1903
|
* See Chromium's accessibility docs for more details. Disabled by default.
|
|
@@ -10226,8 +10226,8 @@ declare namespace Electron {
|
|
|
10226
10226
|
* see Response.
|
|
10227
10227
|
*
|
|
10228
10228
|
* Sends a request, similarly to how `fetch()` works in the renderer, using
|
|
10229
|
-
*
|
|
10230
|
-
* HTTP stack.
|
|
10229
|
+
* Chromium's network stack. This differs from Node's `fetch()`, which uses
|
|
10230
|
+
* Node.js's HTTP stack.
|
|
10231
10231
|
*
|
|
10232
10232
|
* Example:
|
|
10233
10233
|
*
|
|
@@ -13000,8 +13000,8 @@ declare namespace Electron {
|
|
|
13000
13000
|
* see Response.
|
|
13001
13001
|
*
|
|
13002
13002
|
* Sends a request, similarly to how `fetch()` works in the renderer, using
|
|
13003
|
-
*
|
|
13004
|
-
* HTTP stack.
|
|
13003
|
+
* Chromium's network stack. This differs from Node's `fetch()`, which uses
|
|
13004
|
+
* Node.js's HTTP stack.
|
|
13005
13005
|
*
|
|
13006
13006
|
* Example:
|
|
13007
13007
|
*
|
|
@@ -17155,23 +17155,23 @@ declare namespace Electron {
|
|
|
17155
17155
|
* The usage is the same with the `login` event of `app`.
|
|
17156
17156
|
*/
|
|
17157
17157
|
on(event: 'login', listener: (event: Event,
|
|
17158
|
-
authenticationResponseDetails:
|
|
17158
|
+
authenticationResponseDetails: AuthenticationResponseDetails,
|
|
17159
17159
|
authInfo: AuthInfo,
|
|
17160
17160
|
callback: (username?: string, password?: string) => void) => void): this;
|
|
17161
17161
|
off(event: 'login', listener: (event: Event,
|
|
17162
|
-
authenticationResponseDetails:
|
|
17162
|
+
authenticationResponseDetails: AuthenticationResponseDetails,
|
|
17163
17163
|
authInfo: AuthInfo,
|
|
17164
17164
|
callback: (username?: string, password?: string) => void) => void): this;
|
|
17165
17165
|
once(event: 'login', listener: (event: Event,
|
|
17166
|
-
authenticationResponseDetails:
|
|
17166
|
+
authenticationResponseDetails: AuthenticationResponseDetails,
|
|
17167
17167
|
authInfo: AuthInfo,
|
|
17168
17168
|
callback: (username?: string, password?: string) => void) => void): this;
|
|
17169
17169
|
addListener(event: 'login', listener: (event: Event,
|
|
17170
|
-
authenticationResponseDetails:
|
|
17170
|
+
authenticationResponseDetails: AuthenticationResponseDetails,
|
|
17171
17171
|
authInfo: AuthInfo,
|
|
17172
17172
|
callback: (username?: string, password?: string) => void) => void): this;
|
|
17173
17173
|
removeListener(event: 'login', listener: (event: Event,
|
|
17174
|
-
authenticationResponseDetails:
|
|
17174
|
+
authenticationResponseDetails: AuthenticationResponseDetails,
|
|
17175
17175
|
authInfo: AuthInfo,
|
|
17176
17176
|
callback: (username?: string, password?: string) => void) => void): this;
|
|
17177
17177
|
/**
|
|
@@ -20544,6 +20544,18 @@ declare namespace Electron {
|
|
|
20544
20544
|
interface AuthenticationResponseDetails {
|
|
20545
20545
|
url: string;
|
|
20546
20546
|
pid: number;
|
|
20547
|
+
/**
|
|
20548
|
+
* Indicates whether the request is for a navigation.
|
|
20549
|
+
*/
|
|
20550
|
+
isRequestForNavigation: boolean;
|
|
20551
|
+
/**
|
|
20552
|
+
* Indicates whether this is the first authentication attempt.
|
|
20553
|
+
*/
|
|
20554
|
+
firstAuthAttempt: boolean;
|
|
20555
|
+
/**
|
|
20556
|
+
* The headers returned in the response.
|
|
20557
|
+
*/
|
|
20558
|
+
responseHeaders?: Record<string, (string) | (string[])>;
|
|
20547
20559
|
}
|
|
20548
20560
|
|
|
20549
20561
|
interface AuthInfo {
|
|
@@ -22101,10 +22113,6 @@ declare namespace Electron {
|
|
|
22101
22113
|
baseURLForDataURL?: string;
|
|
22102
22114
|
}
|
|
22103
22115
|
|
|
22104
|
-
interface LoginAuthenticationResponseDetails {
|
|
22105
|
-
url: string;
|
|
22106
|
-
}
|
|
22107
|
-
|
|
22108
22116
|
interface LoginItemSettings {
|
|
22109
22117
|
/**
|
|
22110
22118
|
* `true` if the app is set to open at login.
|
|
@@ -23785,6 +23793,15 @@ declare namespace Electron {
|
|
|
23785
23793
|
* The total amount of memory not being used by applications or disk cache.
|
|
23786
23794
|
*/
|
|
23787
23795
|
free: number;
|
|
23796
|
+
/**
|
|
23797
|
+
* The kernel's estimate of the amount of memory available for allocation without
|
|
23798
|
+
* swapping, from `/proc/meminfo` `MemAvailable`. Use this as the memory pressure
|
|
23799
|
+
* signal on Linux; `free` there is `MemFree`, which excludes page cache and other
|
|
23800
|
+
* reclaimable memory.
|
|
23801
|
+
*
|
|
23802
|
+
* @platform linux
|
|
23803
|
+
*/
|
|
23804
|
+
available: number;
|
|
23788
23805
|
/**
|
|
23789
23806
|
* The amount of memory that currently has been paged out to storage. Includes
|
|
23790
23807
|
* memory for file caches, network buffers, and other system services.
|
|
@@ -25138,7 +25155,6 @@ declare namespace Electron {
|
|
|
25138
25155
|
type LoadExtensionOptions = Electron.LoadExtensionOptions;
|
|
25139
25156
|
type LoadFileOptions = Electron.LoadFileOptions;
|
|
25140
25157
|
type LoadURLOptions = Electron.LoadURLOptions;
|
|
25141
|
-
type LoginAuthenticationResponseDetails = Electron.LoginAuthenticationResponseDetails;
|
|
25142
25158
|
type LoginItemSettings = Electron.LoginItemSettings;
|
|
25143
25159
|
type LoginItemSettingsOptions = Electron.LoginItemSettingsOptions;
|
|
25144
25160
|
type MenuItemConstructorOptions = Electron.MenuItemConstructorOptions;
|
|
@@ -25548,7 +25564,6 @@ declare namespace Electron {
|
|
|
25548
25564
|
type LoadExtensionOptions = Electron.LoadExtensionOptions;
|
|
25549
25565
|
type LoadFileOptions = Electron.LoadFileOptions;
|
|
25550
25566
|
type LoadURLOptions = Electron.LoadURLOptions;
|
|
25551
|
-
type LoginAuthenticationResponseDetails = Electron.LoginAuthenticationResponseDetails;
|
|
25552
25567
|
type LoginItemSettings = Electron.LoginItemSettings;
|
|
25553
25568
|
type LoginItemSettingsOptions = Electron.LoginItemSettingsOptions;
|
|
25554
25569
|
type MenuItemConstructorOptions = Electron.MenuItemConstructorOptions;
|
|
@@ -25885,7 +25900,6 @@ declare namespace Electron {
|
|
|
25885
25900
|
type LoadExtensionOptions = Electron.LoadExtensionOptions;
|
|
25886
25901
|
type LoadFileOptions = Electron.LoadFileOptions;
|
|
25887
25902
|
type LoadURLOptions = Electron.LoadURLOptions;
|
|
25888
|
-
type LoginAuthenticationResponseDetails = Electron.LoginAuthenticationResponseDetails;
|
|
25889
25903
|
type LoginItemSettings = Electron.LoginItemSettings;
|
|
25890
25904
|
type LoginItemSettingsOptions = Electron.LoginItemSettingsOptions;
|
|
25891
25905
|
type MenuItemConstructorOptions = Electron.MenuItemConstructorOptions;
|
|
@@ -26221,7 +26235,6 @@ declare namespace Electron {
|
|
|
26221
26235
|
type LoadExtensionOptions = Electron.LoadExtensionOptions;
|
|
26222
26236
|
type LoadFileOptions = Electron.LoadFileOptions;
|
|
26223
26237
|
type LoadURLOptions = Electron.LoadURLOptions;
|
|
26224
|
-
type LoginAuthenticationResponseDetails = Electron.LoginAuthenticationResponseDetails;
|
|
26225
26238
|
type LoginItemSettings = Electron.LoginItemSettings;
|
|
26226
26239
|
type LoginItemSettingsOptions = Electron.LoginItemSettingsOptions;
|
|
26227
26240
|
type MenuItemConstructorOptions = Electron.MenuItemConstructorOptions;
|
|
@@ -26652,7 +26665,6 @@ declare namespace Electron {
|
|
|
26652
26665
|
type LoadExtensionOptions = Electron.LoadExtensionOptions;
|
|
26653
26666
|
type LoadFileOptions = Electron.LoadFileOptions;
|
|
26654
26667
|
type LoadURLOptions = Electron.LoadURLOptions;
|
|
26655
|
-
type LoginAuthenticationResponseDetails = Electron.LoginAuthenticationResponseDetails;
|
|
26656
26668
|
type LoginItemSettings = Electron.LoginItemSettings;
|
|
26657
26669
|
type LoginItemSettingsOptions = Electron.LoginItemSettingsOptions;
|
|
26658
26670
|
type MenuItemConstructorOptions = Electron.MenuItemConstructorOptions;
|
|
@@ -27048,6 +27060,10 @@ declare namespace NodeJS {
|
|
|
27048
27060
|
* to the system.
|
|
27049
27061
|
* * `free` Integer - The total amount of memory not being used by applications or
|
|
27050
27062
|
* disk cache.
|
|
27063
|
+
* * `available` Integer _Linux_ - The kernel's estimate of the amount of memory
|
|
27064
|
+
* available for allocation without swapping, from `/proc/meminfo` `MemAvailable`.
|
|
27065
|
+
* Use this as the memory pressure signal on Linux; `free` there is `MemFree`,
|
|
27066
|
+
* which excludes page cache and other reclaimable memory.
|
|
27051
27067
|
* * `fileBacked` Integer _macOS_ - The amount of memory that currently has been
|
|
27052
27068
|
* paged out to storage. Includes memory for file caches, network buffers, and
|
|
27053
27069
|
* other system services.
|
package/dist/version.json
CHANGED