electron-types 41.0.0-beta.5 → 41.0.0-beta.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 +29 -19
- package/dist/version.json +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -11,11 +11,11 @@ The official `electron` package is ~200MB because it includes the Electron binar
|
|
|
11
11
|
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)):
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
|
-
npm install -D electron-types@41.0.0-beta.
|
|
14
|
+
npm install -D electron-types@41.0.0-beta.7
|
|
15
15
|
# or
|
|
16
|
-
yarn add -D electron-types@41.0.0-beta.
|
|
16
|
+
yarn add -D electron-types@41.0.0-beta.7
|
|
17
17
|
# or
|
|
18
|
-
pnpm add -D electron-types@41.0.0-beta.
|
|
18
|
+
pnpm add -D electron-types@41.0.0-beta.7
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
## Usage
|
package/dist/electron.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Type definitions for Electron 41.0.0-beta.
|
|
1
|
+
// Type definitions for Electron 41.0.0-beta.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
|
|
@@ -1213,7 +1213,7 @@ declare namespace Electron {
|
|
|
1213
1213
|
* indicates that the app should restore the windows that were open the last time
|
|
1214
1214
|
* the app was closed. This setting is not available on MAS builds or on macOS 13
|
|
1215
1215
|
* and up.
|
|
1216
|
-
* * `status` string _macOS_ - can be
|
|
1216
|
+
* * `status` string _macOS_ - can be `not-registered`, `enabled`,
|
|
1217
1217
|
* `requires-approval`, or `not-found`.
|
|
1218
1218
|
* * `executableWillLaunchAtLogin` boolean _Windows_ - `true` if app is set to open
|
|
1219
1219
|
* at login and its run key is not deactivated. This differs from `openAtLogin` as
|
|
@@ -1225,7 +1225,7 @@ declare namespace Electron {
|
|
|
1225
1225
|
* registry entry.
|
|
1226
1226
|
* * `args` string[] _Windows_ - the command-line arguments to pass to the
|
|
1227
1227
|
* executable.
|
|
1228
|
-
* * `scope` string _Windows_ -
|
|
1228
|
+
* * `scope` string _Windows_ - can be `user` or `machine`. Indicates whether the
|
|
1229
1229
|
* registry entry is under `HKEY_CURRENT USER` or `HKEY_LOCAL_MACHINE`.
|
|
1230
1230
|
* * `enabled` boolean _Windows_ - `true` if the app registry key is startup
|
|
1231
1231
|
* approved and therefore shows as `enabled` in Task Manager and Windows settings.
|
|
@@ -9416,8 +9416,9 @@ declare namespace Electron {
|
|
|
9416
9416
|
*/
|
|
9417
9417
|
accelerator: (Accelerator) | (null);
|
|
9418
9418
|
/**
|
|
9419
|
-
* A `boolean` indicating whether the item is checked.
|
|
9420
|
-
*
|
|
9419
|
+
* A `boolean` indicating whether the item is checked.
|
|
9420
|
+
*
|
|
9421
|
+
* This property can be dynamically changed.
|
|
9421
9422
|
*
|
|
9422
9423
|
* A `checkbox` menu item will toggle the `checked` property on and off when
|
|
9423
9424
|
* selected.
|
|
@@ -9442,21 +9443,27 @@ declare namespace Electron {
|
|
|
9442
9443
|
*/
|
|
9443
9444
|
commandId: number;
|
|
9444
9445
|
/**
|
|
9445
|
-
* A `boolean` indicating whether the item is enabled.
|
|
9446
|
-
*
|
|
9446
|
+
* A `boolean` indicating whether the item is enabled.
|
|
9447
|
+
*
|
|
9448
|
+
* This property can be dynamically changed.
|
|
9447
9449
|
*/
|
|
9448
9450
|
enabled: boolean;
|
|
9449
9451
|
/**
|
|
9450
9452
|
* A `NativeImage | string` (optional) indicating the item's icon, if set.
|
|
9453
|
+
*
|
|
9454
|
+
* This property can be dynamically changed.
|
|
9451
9455
|
*/
|
|
9452
9456
|
icon?: (NativeImage) | (string);
|
|
9453
9457
|
/**
|
|
9454
|
-
* A `string` indicating the item's unique id.
|
|
9455
|
-
*
|
|
9458
|
+
* A `string` indicating the item's unique id.
|
|
9459
|
+
*
|
|
9460
|
+
* This property can be dynamically changed.
|
|
9456
9461
|
*/
|
|
9457
9462
|
id: string;
|
|
9458
9463
|
/**
|
|
9459
9464
|
* A `string` indicating the item's visible label.
|
|
9465
|
+
*
|
|
9466
|
+
* This property can be dynamically changed.
|
|
9460
9467
|
*/
|
|
9461
9468
|
label: string;
|
|
9462
9469
|
/**
|
|
@@ -9492,6 +9499,8 @@ declare namespace Electron {
|
|
|
9492
9499
|
sharingItem: SharingItem;
|
|
9493
9500
|
/**
|
|
9494
9501
|
* A `string` indicating the item's sublabel.
|
|
9502
|
+
*
|
|
9503
|
+
* This property can be dynamically changed.
|
|
9495
9504
|
*/
|
|
9496
9505
|
sublabel: string;
|
|
9497
9506
|
/**
|
|
@@ -9524,8 +9533,9 @@ declare namespace Electron {
|
|
|
9524
9533
|
*/
|
|
9525
9534
|
readonly userAccelerator: (Accelerator) | (null);
|
|
9526
9535
|
/**
|
|
9527
|
-
* A `boolean` indicating whether the item is visible.
|
|
9528
|
-
*
|
|
9536
|
+
* A `boolean` indicating whether the item is visible.
|
|
9537
|
+
*
|
|
9538
|
+
* This property can be dynamically changed.
|
|
9529
9539
|
*/
|
|
9530
9540
|
visible: boolean;
|
|
9531
9541
|
}
|
|
@@ -21374,11 +21384,11 @@ declare namespace Electron {
|
|
|
21374
21384
|
*/
|
|
21375
21385
|
restoreState: boolean;
|
|
21376
21386
|
/**
|
|
21377
|
-
* can be
|
|
21387
|
+
* can be `not-registered`, `enabled`, `requires-approval`, or `not-found`.
|
|
21378
21388
|
*
|
|
21379
21389
|
* @platform darwin
|
|
21380
21390
|
*/
|
|
21381
|
-
status:
|
|
21391
|
+
status: ('not-registered' | 'enabled' | 'requires-approval' | 'not-found');
|
|
21382
21392
|
/**
|
|
21383
21393
|
* `true` if app is set to open at login and its run key is not deactivated. This
|
|
21384
21394
|
* differs from `openAtLogin` as it ignores the `args` option, this property will
|
|
@@ -21393,13 +21403,13 @@ declare namespace Electron {
|
|
|
21393
21403
|
|
|
21394
21404
|
interface LoginItemSettingsOptions {
|
|
21395
21405
|
/**
|
|
21396
|
-
* Can be
|
|
21397
|
-
*
|
|
21398
|
-
*
|
|
21406
|
+
* Can be `mainAppService`, `agentService`, `daemonService`, or `loginItemService`.
|
|
21407
|
+
* Defaults to `mainAppService`. Only available on macOS 13 and up. See
|
|
21408
|
+
* app.setLoginItemSettings for more information about each type.
|
|
21399
21409
|
*
|
|
21400
21410
|
* @platform darwin
|
|
21401
21411
|
*/
|
|
21402
|
-
type?:
|
|
21412
|
+
type?: ('mainAppService' | 'agentService' | 'daemonService' | 'loginItemService');
|
|
21403
21413
|
/**
|
|
21404
21414
|
* The name of the service. Required if `type` is non-default. Only available on
|
|
21405
21415
|
* macOS 13 and up.
|
|
@@ -23817,12 +23827,12 @@ declare namespace Electron {
|
|
|
23817
23827
|
*/
|
|
23818
23828
|
args: string[];
|
|
23819
23829
|
/**
|
|
23820
|
-
*
|
|
23830
|
+
* can be `user` or `machine`. Indicates whether the registry entry is under
|
|
23821
23831
|
* `HKEY_CURRENT USER` or `HKEY_LOCAL_MACHINE`.
|
|
23822
23832
|
*
|
|
23823
23833
|
* @platform win32
|
|
23824
23834
|
*/
|
|
23825
|
-
scope:
|
|
23835
|
+
scope: ('user' | 'machine');
|
|
23826
23836
|
/**
|
|
23827
23837
|
* `true` if the app registry key is startup approved and therefore shows as
|
|
23828
23838
|
* `enabled` in Task Manager and Windows settings.
|
package/dist/version.json
CHANGED