electron 16.0.2 → 17.0.0-alpha.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/checksums.json +78 -78
  2. package/electron.d.ts +204 -207
  3. package/package.json +1 -1
package/electron.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // Type definitions for Electron 16.0.2
1
+ // Type definitions for Electron 17.0.0-alpha.4
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/electron-typescript-definitions
@@ -303,19 +303,6 @@ declare namespace Electron {
303
303
  * A string with the error's localized description.
304
304
  */
305
305
  error: string) => void): this;
306
- /**
307
- * Emitted when `desktopCapturer.getSources()` is called in the renderer process of
308
- * `webContents`. Calling `event.preventDefault()` will make it return empty
309
- * sources.
310
- */
311
- on(event: 'desktop-capturer-get-sources', listener: (event: Event,
312
- webContents: WebContents) => void): this;
313
- once(event: 'desktop-capturer-get-sources', listener: (event: Event,
314
- webContents: WebContents) => void): this;
315
- addListener(event: 'desktop-capturer-get-sources', listener: (event: Event,
316
- webContents: WebContents) => void): this;
317
- removeListener(event: 'desktop-capturer-get-sources', listener: (event: Event,
318
- webContents: WebContents) => void): this;
319
306
  /**
320
307
  * Emitted when mac application become active. Difference from `activate` event is
321
308
  * that `did-become-active` is emitted every time the app becomes active, not only
@@ -805,8 +792,8 @@ declare namespace Electron {
805
792
  * Resolve with an object containing the following:
806
793
  *
807
794
  * * `icon` NativeImage - the display icon of the app handling the protocol.
808
- * * `path` String - installation path of the app handling the protocol.
809
- * * `name` String - display name of the app handling the protocol.
795
+ * * `path` string - installation path of the app handling the protocol.
796
+ * * `name` string - display name of the app handling the protocol.
810
797
  *
811
798
  * This method returns a promise that contains the application name, icon and path
812
799
  * of the default handler for the protocol (aka URI scheme) of a URL.
@@ -917,31 +904,31 @@ declare namespace Electron {
917
904
  * you need to pass the same arguments here for `openAtLogin` to be set correctly.
918
905
  *
919
906
  *
920
- * * `openAtLogin` Boolean - `true` if the app is set to open at login.
921
- * * `openAsHidden` Boolean _macOS_ - `true` if the app is set to open as hidden at
907
+ * * `openAtLogin` boolean - `true` if the app is set to open at login.
908
+ * * `openAsHidden` boolean _macOS_ - `true` if the app is set to open as hidden at
922
909
  * login. This setting is not available on MAS builds.
923
- * * `wasOpenedAtLogin` Boolean _macOS_ - `true` if the app was opened at login
910
+ * * `wasOpenedAtLogin` boolean _macOS_ - `true` if the app was opened at login
924
911
  * automatically. This setting is not available on MAS builds.
925
- * * `wasOpenedAsHidden` Boolean _macOS_ - `true` if the app was opened as a hidden
912
+ * * `wasOpenedAsHidden` boolean _macOS_ - `true` if the app was opened as a hidden
926
913
  * login item. This indicates that the app should not open any windows at startup.
927
914
  * This setting is not available on MAS builds.
928
- * * `restoreState` Boolean _macOS_ - `true` if the app was opened as a login item
915
+ * * `restoreState` boolean _macOS_ - `true` if the app was opened as a login item
929
916
  * that should restore the state from the previous session. This indicates that the
930
917
  * app should restore the windows that were open the last time the app was closed.
931
918
  * This setting is not available on MAS builds.
932
- * * `executableWillLaunchAtLogin` Boolean _Windows_ - `true` if app is set to open
919
+ * * `executableWillLaunchAtLogin` boolean _Windows_ - `true` if app is set to open
933
920
  * at login and its run key is not deactivated. This differs from `openAtLogin` as
934
921
  * it ignores the `args` option, this property will be true if the given executable
935
922
  * would be launched at login with **any** arguments.
936
923
  * * `launchItems` Object[] _Windows_
937
- * * `name` String _Windows_ - name value of a registry entry.
938
- * * `path` String _Windows_ - The executable to an app that corresponds to a
924
+ * * `name` string _Windows_ - name value of a registry entry.
925
+ * * `path` string _Windows_ - The executable to an app that corresponds to a
939
926
  * registry entry.
940
- * * `args` String[] _Windows_ - the command-line arguments to pass to the
927
+ * * `args` string[] _Windows_ - the command-line arguments to pass to the
941
928
  * executable.
942
- * * `scope` String _Windows_ - one of `user` or `machine`. Indicates whether the
929
+ * * `scope` string _Windows_ - one of `user` or `machine`. Indicates whether the
943
930
  * registry entry is under `HKEY_CURRENT USER` or `HKEY_LOCAL_MACHINE`.
944
- * * `enabled` Boolean _Windows_ - `true` if the app registry key is startup
931
+ * * `enabled` boolean _Windows_ - `true` if the app registry key is startup
945
932
  * approved and therefore shows as `enabled` in Task Manager and Windows settings.
946
933
  *
947
934
  * @platform darwin,win32
@@ -1400,7 +1387,7 @@ declare namespace Electron {
1400
1387
  */
1401
1388
  whenReady(): Promise<void>;
1402
1389
  /**
1403
- * A `Boolean` property that's `true` if Chrome's accessibility support is enabled,
1390
+ * A `boolean` property that's `true` if Chrome's accessibility support is enabled,
1404
1391
  * `false` otherwise. This property will be `true` if the use of assistive
1405
1392
  * technologies, such as screen readers, has been detected. Setting this property
1406
1393
  * to `true` manually enables Chrome's accessibility support, allowing developers
@@ -1451,14 +1438,14 @@ declare namespace Electron {
1451
1438
  */
1452
1439
  readonly dock: Dock;
1453
1440
  /**
1454
- * A `Boolean` property that returns `true` if the app is packaged, `false`
1441
+ * A `boolean` property that returns `true` if the app is packaged, `false`
1455
1442
  * otherwise. For many apps, this property can be used to distinguish development
1456
1443
  * and production environments.
1457
1444
  *
1458
1445
  */
1459
1446
  readonly isPackaged: boolean;
1460
1447
  /**
1461
- * A `String` property that indicates the current application's name, which is the
1448
+ * A `string` property that indicates the current application's name, which is the
1462
1449
  * name in the application's `package.json` file.
1463
1450
  *
1464
1451
  * Usually the `name` field of `package.json` is a short lowercase name, according
@@ -1468,7 +1455,7 @@ declare namespace Electron {
1468
1455
  */
1469
1456
  name: string;
1470
1457
  /**
1471
- * A `Boolean` which when `true` indicates that the app is currently running under
1458
+ * A `boolean` which when `true` indicates that the app is currently running under
1472
1459
  * an ARM64 translator (like the macOS Rosetta Translator Environment or Windows
1473
1460
  * WOW).
1474
1461
  *
@@ -1479,7 +1466,7 @@ declare namespace Electron {
1479
1466
  */
1480
1467
  readonly runningUnderARM64Translation: boolean;
1481
1468
  /**
1482
- * A `Boolean` which when `true` indicates that the app is currently running under
1469
+ * A `boolean` which when `true` indicates that the app is currently running under
1483
1470
  * the Rosetta Translator Environment.
1484
1471
  *
1485
1472
  * You can use this property to prompt users to download the arm64 version of your
@@ -1494,7 +1481,7 @@ declare namespace Electron {
1494
1481
  */
1495
1482
  readonly runningUnderRosettaTranslation: boolean;
1496
1483
  /**
1497
- * A `String` which is the user agent string Electron will use as a global
1484
+ * A `string` which is the user agent string Electron will use as a global
1498
1485
  * fallback.
1499
1486
  *
1500
1487
  * This is the user agent that will be used when no user agent is set at the
@@ -2780,7 +2767,7 @@ declare namespace Electron {
2780
2767
  * Whether the buttons were added successfully
2781
2768
  *
2782
2769
  * Add a thumbnail toolbar with a specified set of buttons to the thumbnail image
2783
- * of a window in a taskbar button layout. Returns a `Boolean` object indicates
2770
+ * of a window in a taskbar button layout. Returns a `boolean` object indicates
2784
2771
  * whether the thumbnail has been added successfully.
2785
2772
  *
2786
2773
  * The number of buttons in thumbnail toolbar should be no greater than 7 due to
@@ -2793,11 +2780,11 @@ declare namespace Electron {
2793
2780
  * * `Button` Object
2794
2781
  * * `icon` NativeImage - The icon showing in thumbnail toolbar.
2795
2782
  * * `click` Function
2796
- * * `tooltip` String (optional) - The text of the button's tooltip.
2797
- * * `flags` String[] (optional) - Control specific states and behaviors of the
2783
+ * * `tooltip` string (optional) - The text of the button's tooltip.
2784
+ * * `flags` string[] (optional) - Control specific states and behaviors of the
2798
2785
  * button. By default, it is `['enabled']`.
2799
2786
  *
2800
- * The `flags` is an array that can include following `String`s:
2787
+ * The `flags` is an array that can include following `string`s:
2801
2788
  *
2802
2789
  * * `enabled` - The button is active and available to the user.
2803
2790
  * * `disabled` - The button is disabled. It is present, but has a visual state
@@ -2917,13 +2904,13 @@ declare namespace Electron {
2917
2904
  */
2918
2905
  unmaximize(): void;
2919
2906
  /**
2920
- * A `String` property that defines an alternative title provided only to
2907
+ * A `string` property that defines an alternative title provided only to
2921
2908
  * accessibility tools such as screen readers. This string is not directly visible
2922
2909
  * to users.
2923
2910
  */
2924
2911
  accessibleTitle: string;
2925
2912
  /**
2926
- * A `Boolean` property that determines whether the window menu bar should hide
2913
+ * A `boolean` property that determines whether the window menu bar should hide
2927
2914
  * itself automatically. Once set, the menu bar will only show when users press the
2928
2915
  * single `Alt` key.
2929
2916
  *
@@ -2932,14 +2919,14 @@ declare namespace Electron {
2932
2919
  */
2933
2920
  autoHideMenuBar: boolean;
2934
2921
  /**
2935
- * A `Boolean` property that determines whether the window can be manually closed
2922
+ * A `boolean` property that determines whether the window can be manually closed
2936
2923
  * by user.
2937
2924
  *
2938
2925
  * On Linux the setter is a no-op, although the getter returns `true`.
2939
2926
  */
2940
2927
  closable: boolean;
2941
2928
  /**
2942
- * A `Boolean` property that specifies whether the window’s document has been
2929
+ * A `boolean` property that specifies whether the window’s document has been
2943
2930
  * edited.
2944
2931
  *
2945
2932
  * The icon in title bar will become gray when set to `true`.
@@ -2948,24 +2935,24 @@ declare namespace Electron {
2948
2935
  */
2949
2936
  documentEdited: boolean;
2950
2937
  /**
2951
- * A `Boolean` property that determines whether the window is excluded from the
2938
+ * A `boolean` property that determines whether the window is excluded from the
2952
2939
  * application’s Windows menu. `false` by default.
2953
2940
  *
2954
2941
  * @platform darwin
2955
2942
  */
2956
2943
  excludedFromShownWindowsMenu: boolean;
2957
2944
  /**
2958
- * A `Boolean` property that determines whether the window is focusable.
2945
+ * A `boolean` property that determines whether the window is focusable.
2959
2946
  *
2960
2947
  * @platform win32,darwin
2961
2948
  */
2962
2949
  focusable: boolean;
2963
2950
  /**
2964
- * A `Boolean` property that determines whether the window is in fullscreen mode.
2951
+ * A `boolean` property that determines whether the window is in fullscreen mode.
2965
2952
  */
2966
2953
  fullScreen: boolean;
2967
2954
  /**
2968
- * A `Boolean` property that determines whether the maximize/zoom window button
2955
+ * A `boolean` property that determines whether the maximize/zoom window button
2969
2956
  * toggles fullscreen mode or maximizes the window.
2970
2957
  */
2971
2958
  fullScreenable: boolean;
@@ -2976,18 +2963,18 @@ declare namespace Electron {
2976
2963
  */
2977
2964
  readonly id: number;
2978
2965
  /**
2979
- * A `Boolean` property that determines whether the window is in kiosk mode.
2966
+ * A `boolean` property that determines whether the window is in kiosk mode.
2980
2967
  */
2981
2968
  kiosk: boolean;
2982
2969
  /**
2983
- * A `Boolean` property that determines whether the window can be manually
2970
+ * A `boolean` property that determines whether the window can be manually
2984
2971
  * maximized by user.
2985
2972
  *
2986
2973
  * On Linux the setter is a no-op, although the getter returns `true`.
2987
2974
  */
2988
2975
  maximizable: boolean;
2989
2976
  /**
2990
- * A `Boolean` property that determines whether the menu bar should be visible.
2977
+ * A `boolean` property that determines whether the menu bar should be visible.
2991
2978
  *
2992
2979
  * **Note:** If the menu bar is auto-hide, users can still bring up the menu bar by
2993
2980
  * pressing the single `Alt` key.
@@ -2996,48 +2983,48 @@ declare namespace Electron {
2996
2983
  */
2997
2984
  menuBarVisible: boolean;
2998
2985
  /**
2999
- * A `Boolean` property that determines whether the window can be manually
2986
+ * A `boolean` property that determines whether the window can be manually
3000
2987
  * minimized by user.
3001
2988
  *
3002
2989
  * On Linux the setter is a no-op, although the getter returns `true`.
3003
2990
  */
3004
2991
  minimizable: boolean;
3005
2992
  /**
3006
- * A `Boolean` property that determines Whether the window can be moved by user.
2993
+ * A `boolean` property that determines Whether the window can be moved by user.
3007
2994
  *
3008
2995
  * On Linux the setter is a no-op, although the getter returns `true`.
3009
2996
  */
3010
2997
  movable: boolean;
3011
2998
  /**
3012
- * A `String` property that determines the pathname of the file the window
2999
+ * A `string` property that determines the pathname of the file the window
3013
3000
  * represents, and the icon of the file will show in window's title bar.
3014
3001
  *
3015
3002
  * @platform darwin
3016
3003
  */
3017
3004
  representedFilename: string;
3018
3005
  /**
3019
- * A `Boolean` property that determines whether the window can be manually resized
3006
+ * A `boolean` property that determines whether the window can be manually resized
3020
3007
  * by user.
3021
3008
  */
3022
3009
  resizable: boolean;
3023
3010
  /**
3024
- * A `Boolean` property that determines whether the window has a shadow.
3011
+ * A `boolean` property that determines whether the window has a shadow.
3025
3012
  */
3026
3013
  shadow: boolean;
3027
3014
  /**
3028
- * A `Boolean` property that determines whether the window is in simple (pre-Lion)
3015
+ * A `boolean` property that determines whether the window is in simple (pre-Lion)
3029
3016
  * fullscreen mode.
3030
3017
  */
3031
3018
  simpleFullScreen: boolean;
3032
3019
  /**
3033
- * A `String` property that determines the title of the native window.
3020
+ * A `string` property that determines the title of the native window.
3034
3021
  *
3035
3022
  * **Note:** The title of the web page can be different from the title of the
3036
3023
  * native window.
3037
3024
  */
3038
3025
  title: string;
3039
3026
  /**
3040
- * A `Boolean` property that determines whether the window is visible on all
3027
+ * A `boolean` property that determines whether the window is visible on all
3041
3028
  * workspaces.
3042
3029
  *
3043
3030
  * **Note:** Always returns false on Windows.
@@ -3086,7 +3073,7 @@ declare namespace Electron {
3086
3073
  */
3087
3074
  print(): void;
3088
3075
  /**
3089
- * A `Boolean` that is set to true after the child window gets closed.
3076
+ * A `boolean` that is set to true after the child window gets closed.
3090
3077
  */
3091
3078
  closed: boolean;
3092
3079
  }
@@ -3226,8 +3213,8 @@ declare namespace Electron {
3226
3213
  *
3227
3214
  * The `callback` function is expected to be called back with user credentials:
3228
3215
  *
3229
- * * `username` String
3230
- * * `password` String
3216
+ * * `username` string
3217
+ * * `password` string
3231
3218
  *
3232
3219
  * Providing empty credentials will cancel the request and report an authentication
3233
3220
  * error on the response object:
@@ -3308,9 +3295,9 @@ declare namespace Electron {
3308
3295
  */
3309
3296
  getHeader(name: string): string;
3310
3297
  /**
3311
- * * `active` Boolean - Whether the request is currently active. If this is false
3298
+ * * `active` boolean - Whether the request is currently active. If this is false
3312
3299
  * no other properties will be set
3313
- * * `started` Boolean - Whether the upload has started. If this is false both
3300
+ * * `started` boolean - Whether the upload has started. If this is false both
3314
3301
  * `current` and `total` will be set to 0.
3315
3302
  * * `current` Integer - The number of bytes that have been uploaded so far
3316
3303
  * * `total` Integer - The number of bytes that will be uploaded this request
@@ -3327,7 +3314,7 @@ declare namespace Electron {
3327
3314
  /**
3328
3315
  * Adds an extra HTTP header. The header name will be issued as-is without
3329
3316
  * lowercasing. It can be called only before first write. Calling this method after
3330
- * the first write will throw an error. If the passed value is not a `String`, its
3317
+ * the first write will throw an error. If the passed value is not a `string`, its
3331
3318
  * `toString()` method will be called to obtain the final value.
3332
3319
  *
3333
3320
  * Certain headers are restricted from being set by apps. These headers are listed
@@ -3359,7 +3346,7 @@ declare namespace Electron {
3359
3346
  */
3360
3347
  write(chunk: (string) | (Buffer), encoding?: string, callback?: () => void): void;
3361
3348
  /**
3362
- * A `Boolean` specifying whether the request will use HTTP chunked transfer
3349
+ * A `boolean` specifying whether the request will use HTTP chunked transfer
3363
3350
  * encoding or not. Defaults to false. The property is readable and writable,
3364
3351
  * however it can be set only before the first write operation as the HTTP headers
3365
3352
  * are not yet put on the wire. Trying to set the `chunkedEncoding` property after
@@ -3400,8 +3387,8 @@ declare namespace Electron {
3400
3387
  */
3401
3388
  read(format: string): string;
3402
3389
  /**
3403
- * * `title` String
3404
- * * `url` String
3390
+ * * `title` string
3391
+ * * `url` string
3405
3392
  *
3406
3393
  * Returns an Object containing `title` and `url` keys representing the bookmark in
3407
3394
  * the clipboard. The `title` and `url` values will be empty strings when the
@@ -3551,8 +3538,8 @@ declare namespace Electron {
3551
3538
  * Resolves with an object containing the `value` and `percentage` of trace buffer
3552
3539
  * maximum usage
3553
3540
  *
3554
- * * `value` Number
3555
- * * `percentage` Number
3541
+ * * `value` number
3542
+ * * `percentage` number
3556
3543
  *
3557
3544
  * Get the maximum usage across processes of trace buffer as a percentage of the
3558
3545
  * full state.
@@ -4079,8 +4066,8 @@ declare namespace Electron {
4079
4066
  /**
4080
4067
  * resolves with a promise containing the following properties:
4081
4068
  *
4082
- * * `response` Number - The index of the clicked button.
4083
- * * `checkboxChecked` Boolean - The checked state of the checkbox if
4069
+ * * `response` number - The index of the clicked button.
4070
+ * * `checkboxChecked` boolean - The checked state of the checkbox if
4084
4071
  * `checkboxLabel` was set. Otherwise `false`.
4085
4072
  *
4086
4073
  * Shows a message box.
@@ -4092,8 +4079,8 @@ declare namespace Electron {
4092
4079
  /**
4093
4080
  * resolves with a promise containing the following properties:
4094
4081
  *
4095
- * * `response` Number - The index of the clicked button.
4096
- * * `checkboxChecked` Boolean - The checked state of the checkbox if
4082
+ * * `response` number - The index of the clicked button.
4083
+ * * `checkboxChecked` boolean - The checked state of the checkbox if
4097
4084
  * `checkboxLabel` was set. Otherwise `false`.
4098
4085
  *
4099
4086
  * Shows a message box.
@@ -4127,10 +4114,10 @@ declare namespace Electron {
4127
4114
  /**
4128
4115
  * Resolve with an object containing the following:
4129
4116
  *
4130
- * * `canceled` Boolean - whether or not the dialog was canceled.
4131
- * * `filePaths` String[] - An array of file paths chosen by the user. If the
4117
+ * * `canceled` boolean - whether or not the dialog was canceled.
4118
+ * * `filePaths` string[] - An array of file paths chosen by the user. If the
4132
4119
  * dialog is cancelled this will be an empty array.
4133
- * * `bookmarks` String[] (optional) _macOS_ _mas_ - An array matching the
4120
+ * * `bookmarks` string[] (optional) _macOS_ _mas_ - An array matching the
4134
4121
  * `filePaths` array of base64 encoded strings which contains security scoped
4135
4122
  * bookmark data. `securityScopedBookmarks` must be enabled for this to be
4136
4123
  * populated. (For return values, see table here.)
@@ -4153,10 +4140,10 @@ declare namespace Electron {
4153
4140
  /**
4154
4141
  * Resolve with an object containing the following:
4155
4142
  *
4156
- * * `canceled` Boolean - whether or not the dialog was canceled.
4157
- * * `filePaths` String[] - An array of file paths chosen by the user. If the
4143
+ * * `canceled` boolean - whether or not the dialog was canceled.
4144
+ * * `filePaths` string[] - An array of file paths chosen by the user. If the
4158
4145
  * dialog is cancelled this will be an empty array.
4159
- * * `bookmarks` String[] (optional) _macOS_ _mas_ - An array matching the
4146
+ * * `bookmarks` string[] (optional) _macOS_ _mas_ - An array matching the
4160
4147
  * `filePaths` array of base64 encoded strings which contains security scoped
4161
4148
  * bookmark data. `securityScopedBookmarks` must be enabled for this to be
4162
4149
  * populated. (For return values, see table here.)
@@ -4217,10 +4204,10 @@ declare namespace Electron {
4217
4204
  /**
4218
4205
  * Resolve with an object containing the following:
4219
4206
  *
4220
- * * `canceled` Boolean - whether or not the dialog was canceled.
4221
- * * `filePath` String (optional) - If the dialog is canceled, this will be
4207
+ * * `canceled` boolean - whether or not the dialog was canceled.
4208
+ * * `filePath` string (optional) - If the dialog is canceled, this will be
4222
4209
  * `undefined`.
4223
- * * `bookmark` String (optional) _macOS_ _mas_ - Base64 encoded string which
4210
+ * * `bookmark` string (optional) _macOS_ _mas_ - Base64 encoded string which
4224
4211
  * contains the security scoped bookmark data for the saved file.
4225
4212
  * `securityScopedBookmarks` must be enabled for this to be present. (For return
4226
4213
  * values, see table here.)
@@ -4238,10 +4225,10 @@ declare namespace Electron {
4238
4225
  /**
4239
4226
  * Resolve with an object containing the following:
4240
4227
  *
4241
- * * `canceled` Boolean - whether or not the dialog was canceled.
4242
- * * `filePath` String (optional) - If the dialog is canceled, this will be
4228
+ * * `canceled` boolean - whether or not the dialog was canceled.
4229
+ * * `filePath` string (optional) - If the dialog is canceled, this will be
4243
4230
  * `undefined`.
4244
- * * `bookmark` String (optional) _macOS_ _mas_ - Base64 encoded string which
4231
+ * * `bookmark` string (optional) _macOS_ _mas_ - Base64 encoded string which
4245
4232
  * contains the security scoped bookmark data for the saved file.
4246
4233
  * `securityScopedBookmarks` must be enabled for this to be present. (For return
4247
4234
  * values, see table here.)
@@ -4594,7 +4581,7 @@ declare namespace Electron {
4594
4581
  */
4595
4582
  setSavePath(path: string): void;
4596
4583
  /**
4597
- * A `String` property that determines the save file path of the download item.
4584
+ * A `string` property that determines the save file path of the download item.
4598
4585
  *
4599
4586
  * The property is only available in session's `will-download` callback function.
4600
4587
  * If user doesn't set the save path via the property, Electron will use the
@@ -4929,7 +4916,7 @@ declare namespace Electron {
4929
4916
  */
4930
4917
  headers: Record<string, (string) | (string[])>;
4931
4918
  /**
4932
- * A `String` indicating the HTTP protocol version number. Typical values are '1.0'
4919
+ * A `string` indicating the HTTP protocol version number. Typical values are '1.0'
4933
4920
  * or '1.1'. Additionally `httpVersionMajor` and `httpVersionMinor` are two
4934
4921
  * Integer-valued readable properties that return respectively the HTTP major and
4935
4922
  * minor version numbers.
@@ -4948,7 +4935,7 @@ declare namespace Electron {
4948
4935
  */
4949
4936
  statusCode: number;
4950
4937
  /**
4951
- * A `String` representing the HTTP status message.
4938
+ * A `string` representing the HTTP status message.
4952
4939
  */
4953
4940
  statusMessage: string;
4954
4941
  }
@@ -5507,7 +5494,7 @@ declare namespace Electron {
5507
5494
  */
5508
5495
  accelerator?: Accelerator;
5509
5496
  /**
5510
- * A `Boolean` indicating whether the item is checked, this property can be
5497
+ * A `boolean` indicating whether the item is checked, this property can be
5511
5498
  * dynamically changed.
5512
5499
  *
5513
5500
  * A `checkbox` menu item will toggle the `checked` property on and off when
@@ -5529,25 +5516,25 @@ declare namespace Electron {
5529
5516
  */
5530
5517
  click: Function;
5531
5518
  /**
5532
- * A `Number` indicating an item's sequential unique id.
5519
+ * A `number` indicating an item's sequential unique id.
5533
5520
  */
5534
5521
  commandId: number;
5535
5522
  /**
5536
- * A `Boolean` indicating whether the item is enabled, this property can be
5523
+ * A `boolean` indicating whether the item is enabled, this property can be
5537
5524
  * dynamically changed.
5538
5525
  */
5539
5526
  enabled: boolean;
5540
5527
  /**
5541
- * A `NativeImage | String` (optional) indicating the item's icon, if set.
5528
+ * A `NativeImage | string` (optional) indicating the item's icon, if set.
5542
5529
  */
5543
5530
  icon?: (NativeImage) | (string);
5544
5531
  /**
5545
- * A `String` indicating the item's unique id, this property can be dynamically
5532
+ * A `string` indicating the item's unique id, this property can be dynamically
5546
5533
  * changed.
5547
5534
  */
5548
5535
  id: string;
5549
5536
  /**
5550
- * A `String` indicating the item's visible label.
5537
+ * A `string` indicating the item's visible label.
5551
5538
  */
5552
5539
  label: string;
5553
5540
  /**
@@ -5555,14 +5542,14 @@ declare namespace Electron {
5555
5542
  */
5556
5543
  menu: Menu;
5557
5544
  /**
5558
- * A `Boolean` indicating if the accelerator should be registered with the system
5545
+ * A `boolean` indicating if the accelerator should be registered with the system
5559
5546
  * or just displayed.
5560
5547
  *
5561
5548
  * This property can be dynamically changed.
5562
5549
  */
5563
5550
  registerAccelerator: boolean;
5564
5551
  /**
5565
- * A `String` (optional) indicating the item's role, if set. Can be `undo`, `redo`,
5552
+ * A `string` (optional) indicating the item's role, if set. Can be `undo`, `redo`,
5566
5553
  * `cut`, `copy`, `paste`, `pasteAndMatchStyle`, `delete`, `selectAll`, `reload`,
5567
5554
  * `forceReload`, `toggleDevTools`, `resetZoom`, `zoomIn`, `zoomOut`,
5568
5555
  * `toggleSpellChecker`, `togglefullscreen`, `window`, `minimize`, `close`, `help`,
@@ -5582,7 +5569,7 @@ declare namespace Electron {
5582
5569
  */
5583
5570
  sharingItem: SharingItem;
5584
5571
  /**
5585
- * A `String` indicating the item's sublabel.
5572
+ * A `string` indicating the item's sublabel.
5586
5573
  */
5587
5574
  sublabel: string;
5588
5575
  /**
@@ -5590,13 +5577,13 @@ declare namespace Electron {
5590
5577
  */
5591
5578
  submenu?: Menu;
5592
5579
  /**
5593
- * A `String` indicating the item's hover text.
5580
+ * A `string` indicating the item's hover text.
5594
5581
  *
5595
5582
  * @platform darwin
5596
5583
  */
5597
5584
  toolTip: string;
5598
5585
  /**
5599
- * A `String` indicating the type of the item. Can be `normal`, `separator`,
5586
+ * A `string` indicating the type of the item. Can be `normal`, `separator`,
5600
5587
  * `submenu`, `checkbox` or `radio`.
5601
5588
  */
5602
5589
  type: ('normal' | 'separator' | 'submenu' | 'checkbox' | 'radio');
@@ -5613,7 +5600,7 @@ declare namespace Electron {
5613
5600
  */
5614
5601
  readonly userAccelerator: (Accelerator) | (null);
5615
5602
  /**
5616
- * A `Boolean` indicating whether the item is visible, this property can be
5603
+ * A `boolean` indicating whether the item is visible, this property can be
5617
5604
  * dynamically changed.
5618
5605
  */
5619
5606
  visible: boolean;
@@ -5873,7 +5860,7 @@ declare namespace Electron {
5873
5860
  */
5874
5861
  toPNG(options?: ToPNGOptions): Buffer;
5875
5862
  /**
5876
- * A `Boolean` property that determines whether the image is considered a template
5863
+ * A `boolean` property that determines whether the image is considered a template
5877
5864
  * image.
5878
5865
  *
5879
5866
  * Please note that this property only has an effect on macOS.
@@ -5898,28 +5885,28 @@ declare namespace Electron {
5898
5885
  addListener(event: 'updated', listener: Function): this;
5899
5886
  removeListener(event: 'updated', listener: Function): this;
5900
5887
  /**
5901
- * A `Boolean` for if the OS / Chromium currently has a dark mode enabled or is
5888
+ * A `boolean` for if the OS / Chromium currently has a dark mode enabled or is
5902
5889
  * being instructed to show a dark-style UI. If you want to modify this value you
5903
5890
  * should use `themeSource` below.
5904
5891
  *
5905
5892
  */
5906
5893
  readonly shouldUseDarkColors: boolean;
5907
5894
  /**
5908
- * A `Boolean` for if the OS / Chromium currently has high-contrast mode enabled or
5895
+ * A `boolean` for if the OS / Chromium currently has high-contrast mode enabled or
5909
5896
  * is being instructed to show a high-contrast UI.
5910
5897
  *
5911
5898
  * @platform darwin,win32
5912
5899
  */
5913
5900
  readonly shouldUseHighContrastColors: boolean;
5914
5901
  /**
5915
- * A `Boolean` for if the OS / Chromium currently has an inverted color scheme or
5902
+ * A `boolean` for if the OS / Chromium currently has an inverted color scheme or
5916
5903
  * is being instructed to use an inverted color scheme.
5917
5904
  *
5918
5905
  * @platform darwin,win32
5919
5906
  */
5920
5907
  readonly shouldUseInvertedColorScheme: boolean;
5921
5908
  /**
5922
- * A `String` property that can be `system`, `light` or `dark`. It is used to
5909
+ * A `string` property that can be `system`, `light` or `dark`. It is used to
5923
5910
  * override and supersede the value that Chromium has chosen to use internally.
5924
5911
  *
5925
5912
  * Setting this property to `system` will remove the override and everything will
@@ -5979,7 +5966,7 @@ declare namespace Electron {
5979
5966
  */
5980
5967
  request(options: (ClientRequestConstructorOptions) | (string)): ClientRequest;
5981
5968
  /**
5982
- * A `Boolean` property. Whether there is currently internet connection.
5969
+ * A `boolean` property. Whether there is currently internet connection.
5983
5970
  *
5984
5971
  * A return value of `false` is a pretty strong indicator that the user won't be
5985
5972
  * able to connect to remote sites. However, a return value of `true` is
@@ -6008,7 +5995,7 @@ declare namespace Electron {
6008
5995
  */
6009
5996
  stopLogging(): Promise<void>;
6010
5997
  /**
6011
- * A `Boolean` property that indicates whether network logs are currently being
5998
+ * A `boolean` property that indicates whether network logs are currently being
6012
5999
  * recorded.
6013
6000
  *
6014
6001
  */
@@ -6151,35 +6138,35 @@ declare namespace Electron {
6151
6138
  */
6152
6139
  actions: NotificationAction[];
6153
6140
  /**
6154
- * A `String` property representing the body of the notification.
6141
+ * A `string` property representing the body of the notification.
6155
6142
  */
6156
6143
  body: string;
6157
6144
  /**
6158
- * A `String` property representing the close button text of the notification.
6145
+ * A `string` property representing the close button text of the notification.
6159
6146
  */
6160
6147
  closeButtonText: string;
6161
6148
  /**
6162
- * A `Boolean` property representing whether the notification has a reply action.
6149
+ * A `boolean` property representing whether the notification has a reply action.
6163
6150
  */
6164
6151
  hasReply: boolean;
6165
6152
  /**
6166
- * A `String` property representing the reply placeholder of the notification.
6153
+ * A `string` property representing the reply placeholder of the notification.
6167
6154
  */
6168
6155
  replyPlaceholder: string;
6169
6156
  /**
6170
- * A `Boolean` property representing whether the notification is silent.
6157
+ * A `boolean` property representing whether the notification is silent.
6171
6158
  */
6172
6159
  silent: boolean;
6173
6160
  /**
6174
- * A `String` property representing the sound of the notification.
6161
+ * A `string` property representing the sound of the notification.
6175
6162
  */
6176
6163
  sound: string;
6177
6164
  /**
6178
- * A `String` property representing the subtitle of the notification.
6165
+ * A `string` property representing the subtitle of the notification.
6179
6166
  */
6180
6167
  subtitle: string;
6181
6168
  /**
6182
- * A `String` property representing the type of timeout duration for the
6169
+ * A `string` property representing the type of timeout duration for the
6183
6170
  * notification. Can be 'default' or 'never'.
6184
6171
  *
6185
6172
  * If `timeoutType` is set to 'never', the notification never expires. It stays
@@ -6189,17 +6176,17 @@ declare namespace Electron {
6189
6176
  */
6190
6177
  timeoutType: ('default' | 'never');
6191
6178
  /**
6192
- * A `String` property representing the title of the notification.
6179
+ * A `string` property representing the title of the notification.
6193
6180
  */
6194
6181
  title: string;
6195
6182
  /**
6196
- * A `String` property representing the custom Toast XML of the notification.
6183
+ * A `string` property representing the custom Toast XML of the notification.
6197
6184
  *
6198
6185
  * @platform win32
6199
6186
  */
6200
6187
  toastXml: string;
6201
6188
  /**
6202
- * A `String` property representing the urgency level of the notification. Can be
6189
+ * A `string` property representing the urgency level of the notification. Can be
6203
6190
  * 'normal', 'critical', or 'low'.
6204
6191
  *
6205
6192
  * Default is 'low' - see NotifyUrgency for more information.
@@ -6386,7 +6373,7 @@ declare namespace Electron {
6386
6373
  */
6387
6374
  isOnBatteryPower(): boolean;
6388
6375
  /**
6389
- * A `Boolean` property. True if the system is on battery power.
6376
+ * A `boolean` property. True if the system is on battery power.
6390
6377
  *
6391
6378
  * See `powerMonitor.isOnBatteryPower()`.
6392
6379
  */
@@ -6546,7 +6533,7 @@ declare namespace Electron {
6546
6533
  */
6547
6534
  formattedPrice: string;
6548
6535
  /**
6549
- * A Boolean value that indicates whether the App Store has downloadable content
6536
+ * A boolean value that indicates whether the App Store has downloadable content
6550
6537
  * for this product. `true` if at least one file has been associated with the
6551
6538
  * product.
6552
6539
  */
@@ -6605,7 +6592,7 @@ declare namespace Electron {
6605
6592
  * Whether the protocol was successfully intercepted
6606
6593
  *
6607
6594
  * Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
6608
- * which sends a `String` as a response.
6595
+ * which sends a `string` as a response.
6609
6596
  */
6610
6597
  interceptStringProtocol(scheme: string, handler: (request: ProtocolRequest, callback: (response: (string) | (ProtocolResponse)) => void) => void): boolean;
6611
6598
  /**
@@ -6708,10 +6695,10 @@ declare namespace Electron {
6708
6695
  /**
6709
6696
  * Whether the protocol was successfully registered
6710
6697
  *
6711
- * Registers a protocol of `scheme` that will send a `String` as a response.
6698
+ * Registers a protocol of `scheme` that will send a `string` as a response.
6712
6699
  *
6713
6700
  * The usage is the same with `registerFileProtocol`, except that the `callback`
6714
- * should be called with either a `String` or an object that has the `data`
6701
+ * should be called with either a `string` or an object that has the `data`
6715
6702
  * property.
6716
6703
  */
6717
6704
  registerStringProtocol(scheme: string, handler: (request: ProtocolRequest, callback: (response: (string) | (ProtocolResponse)) => void) => void): boolean;
@@ -6751,7 +6738,7 @@ declare namespace Electron {
6751
6738
  /**
6752
6739
  * The response body. When returning stream as response, this is a Node.js readable
6753
6740
  * stream representing the response body. When returning `Buffer` as response, this
6754
- * is a `Buffer`. When returning `String` as response, this is a `String`. This is
6741
+ * is a `Buffer`. When returning `string` as response, this is a `string`. This is
6755
6742
  * ignored for other types of responses.
6756
6743
  */
6757
6744
  data?: (Buffer) | (string) | (NodeJS.ReadableStream);
@@ -6761,8 +6748,8 @@ declare namespace Electron {
6761
6748
  */
6762
6749
  error?: number;
6763
6750
  /**
6764
- * An object containing the response headers. The keys must be String, and values
6765
- * must be either String or Array of String.
6751
+ * An object containing the response headers. The keys must be string, and values
6752
+ * must be either string or Array of string.
6766
6753
  */
6767
6754
  headers?: Record<string, (string) | (string[])>;
6768
6755
  /**
@@ -7575,7 +7562,7 @@ declare namespace Electron {
7575
7562
  */
7576
7563
  getSpellCheckerLanguages(): string[];
7577
7564
  /**
7578
- * A `String | null` indicating the absolute file system path where data for this
7565
+ * A `string | null` indicating the absolute file system path where data for this
7579
7566
  * session is persisted on disk. For in memory sessions this returns `null`.
7580
7567
  */
7581
7568
  getStoragePath(): void;
@@ -7812,7 +7799,7 @@ declare namespace Electron {
7812
7799
  */
7813
7800
  setUserAgent(userAgent: string, acceptLanguages?: string): void;
7814
7801
  /**
7815
- * A `String[]` array which consists of all the known available spell checker
7802
+ * A `string[]` array which consists of all the known available spell checker
7816
7803
  * languages. Providing a language code to the `setSpellCheckerLanguages` API that
7817
7804
  * isn't in this array will result in an error.
7818
7805
  *
@@ -7839,11 +7826,11 @@ declare namespace Electron {
7839
7826
  */
7840
7827
  readonly serviceWorkers: ServiceWorkers;
7841
7828
  /**
7842
- * A `Boolean` indicating whether builtin spell checker is enabled.
7829
+ * A `boolean` indicating whether builtin spell checker is enabled.
7843
7830
  */
7844
7831
  spellCheckerEnabled: boolean;
7845
7832
  /**
7846
- * A `String | null` indicating the absolute file system path where data for this
7833
+ * A `string | null` indicating the absolute file system path where data for this
7847
7834
  * session is persisted on disk. For in memory sessions this returns `null`.
7848
7835
  *
7849
7836
  */
@@ -8136,12 +8123,12 @@ declare namespace Electron {
8136
8123
  */
8137
8124
  getAccentColor(): string;
8138
8125
  /**
8139
- * * `shouldRenderRichAnimation` Boolean - Returns true if rich animations should
8126
+ * * `shouldRenderRichAnimation` boolean - Returns true if rich animations should
8140
8127
  * be rendered. Looks at session type (e.g. remote desktop) and accessibility
8141
8128
  * settings to give guidance for heavy animations.
8142
- * * `scrollAnimationsEnabledBySystem` Boolean - Determines on a per-platform basis
8129
+ * * `scrollAnimationsEnabledBySystem` boolean - Determines on a per-platform basis
8143
8130
  * whether scroll animations (e.g. produced by home/end key) should be enabled.
8144
- * * `prefersReducedMotion` Boolean - Determines whether the user desires reduced
8131
+ * * `prefersReducedMotion` boolean - Determines whether the user desires reduced
8145
8132
  * motion based on platform APIs.
8146
8133
  *
8147
8134
  * Returns an object with system animation settings.
@@ -8407,7 +8394,7 @@ declare namespace Electron {
8407
8394
  */
8408
8395
  unsubscribeWorkspaceNotification(id: number): void;
8409
8396
  /**
8410
- * A `String` property that can be `dark`, `light` or `unknown`. It determines the
8397
+ * A `string` property that can be `dark`, `light` or `unknown`. It determines the
8411
8398
  * macOS appearance setting for your application. This maps to values in:
8412
8399
  * NSApplication.appearance. Setting this will override the system default as well
8413
8400
  * as the value of `getEffectiveAppearance`.
@@ -8421,7 +8408,7 @@ declare namespace Electron {
8421
8408
  */
8422
8409
  appLevelAppearance: ('dark' | 'light' | 'unknown');
8423
8410
  /**
8424
- * A `String` property that can be `dark`, `light` or `unknown`.
8411
+ * A `string` property that can be `dark`, `light` or `unknown`.
8425
8412
  *
8426
8413
  * Returns the macOS appearance setting that is currently applied to your
8427
8414
  * application, maps to NSApplication.effectiveAppearance
@@ -8557,17 +8544,17 @@ declare namespace Electron {
8557
8544
  */
8558
8545
  constructor(options: TouchBarButtonConstructorOptions);
8559
8546
  /**
8560
- * A `String` representing the description of the button to be read by a screen
8547
+ * A `string` representing the description of the button to be read by a screen
8561
8548
  * reader. Will only be read by screen readers if no label is set.
8562
8549
  */
8563
8550
  accessibilityLabel: string;
8564
8551
  /**
8565
- * A `String` hex code representing the button's current background color. Changing
8552
+ * A `string` hex code representing the button's current background color. Changing
8566
8553
  * this value immediately updates the button in the touch bar.
8567
8554
  */
8568
8555
  backgroundColor: string;
8569
8556
  /**
8570
- * A `Boolean` representing whether the button is in an enabled state.
8557
+ * A `boolean` representing whether the button is in an enabled state.
8571
8558
  */
8572
8559
  enabled: boolean;
8573
8560
  /**
@@ -8576,11 +8563,11 @@ declare namespace Electron {
8576
8563
  */
8577
8564
  icon: NativeImage;
8578
8565
  /**
8579
- * A `String` - Can be `left`, `right` or `overlay`. Defaults to `overlay`.
8566
+ * A `string` - Can be `left`, `right` or `overlay`. Defaults to `overlay`.
8580
8567
  */
8581
8568
  iconPosition: ('left' | 'right' | 'overlay');
8582
8569
  /**
8583
- * A `String` representing the button's current text. Changing this value
8570
+ * A `string` representing the button's current text. Changing this value
8584
8571
  * immediately updates the button in the touch bar.
8585
8572
  */
8586
8573
  label: string;
@@ -8595,12 +8582,12 @@ declare namespace Electron {
8595
8582
  */
8596
8583
  constructor(options: TouchBarColorPickerConstructorOptions);
8597
8584
  /**
8598
- * A `String[]` array representing the color picker's available colors to select.
8585
+ * A `string[]` array representing the color picker's available colors to select.
8599
8586
  * Changing this value immediately updates the color picker in the touch bar.
8600
8587
  */
8601
8588
  availableColors: string[];
8602
8589
  /**
8603
- * A `String` hex code representing the color picker's currently selected color.
8590
+ * A `string` hex code representing the color picker's currently selected color.
8604
8591
  * Changing this value immediately updates the color picker in the touch bar.
8605
8592
  */
8606
8593
  selectedColor: string;
@@ -8625,17 +8612,17 @@ declare namespace Electron {
8625
8612
  */
8626
8613
  constructor(options: TouchBarLabelConstructorOptions);
8627
8614
  /**
8628
- * A `String` representing the description of the label to be read by a screen
8615
+ * A `string` representing the description of the label to be read by a screen
8629
8616
  * reader.
8630
8617
  */
8631
8618
  accessibilityLabel: string;
8632
8619
  /**
8633
- * A `String` representing the label's current text. Changing this value
8620
+ * A `string` representing the label's current text. Changing this value
8634
8621
  * immediately updates the label in the touch bar.
8635
8622
  */
8636
8623
  label: string;
8637
8624
  /**
8638
- * A `String` hex code representing the label's current text color. Changing this
8625
+ * A `string` hex code representing the label's current text color. Changing this
8639
8626
  * value immediately updates the label in the touch bar.
8640
8627
  */
8641
8628
  textColor: string;
@@ -8665,7 +8652,7 @@ declare namespace Electron {
8665
8652
  */
8666
8653
  icon: NativeImage;
8667
8654
  /**
8668
- * A `String` representing the popover's current button text. Changing this value
8655
+ * A `string` representing the popover's current button text. Changing this value
8669
8656
  * immediately updates the popover in the touch bar.
8670
8657
  */
8671
8658
  label: string;
@@ -8680,7 +8667,7 @@ declare namespace Electron {
8680
8667
  */
8681
8668
  constructor(options: TouchBarScrubberConstructorOptions);
8682
8669
  /**
8683
- * A `Boolean` representing whether this scrubber is continuous or not. Updating
8670
+ * A `boolean` representing whether this scrubber is continuous or not. Updating
8684
8671
  * this value immediately updates the control in the touch bar.
8685
8672
  */
8686
8673
  continuous: boolean;
@@ -8691,7 +8678,7 @@ declare namespace Electron {
8691
8678
  */
8692
8679
  items: ScrubberItem[];
8693
8680
  /**
8694
- * A `String` representing the mode of this scrubber. Updating this value
8681
+ * A `string` representing the mode of this scrubber. Updating this value
8695
8682
  * immediately updates the control in the touch bar. Possible values:
8696
8683
  *
8697
8684
  * * `fixed` - Maps to `NSScrubberModeFixed`.
@@ -8699,7 +8686,7 @@ declare namespace Electron {
8699
8686
  */
8700
8687
  mode: ('fixed' | 'free');
8701
8688
  /**
8702
- * A `String` representing the style that selected items in the scrubber should
8689
+ * A `string` representing the style that selected items in the scrubber should
8703
8690
  * have. This style is overlayed on top of the scrubber item instead of being
8704
8691
  * placed behind it. Updating this value immediately updates the control in the
8705
8692
  * touch bar. Possible values:
@@ -8710,7 +8697,7 @@ declare namespace Electron {
8710
8697
  */
8711
8698
  overlayStyle: ('background' | 'outline' | 'none');
8712
8699
  /**
8713
- * A `String` representing the style that selected items in the scrubber should
8700
+ * A `string` representing the style that selected items in the scrubber should
8714
8701
  * have. Updating this value immediately updates the control in the touch bar.
8715
8702
  * Possible values:
8716
8703
  *
@@ -8720,7 +8707,7 @@ declare namespace Electron {
8720
8707
  */
8721
8708
  selectedStyle: ('background' | 'outline' | 'none');
8722
8709
  /**
8723
- * A `Boolean` representing whether to show the left / right selection arrows in
8710
+ * A `boolean` representing whether to show the left / right selection arrows in
8724
8711
  * this scrubber. Updating this value immediately updates the control in the touch
8725
8712
  * bar.
8726
8713
  */
@@ -8736,7 +8723,7 @@ declare namespace Electron {
8736
8723
  */
8737
8724
  constructor(options: TouchBarSegmentedControlConstructorOptions);
8738
8725
  /**
8739
- * A `String` representing the current selection mode of the control. Can be
8726
+ * A `string` representing the current selection mode of the control. Can be
8740
8727
  * `single`, `multiple` or `buttons`.
8741
8728
  */
8742
8729
  mode: ('single' | 'multiple' | 'buttons');
@@ -8747,7 +8734,7 @@ declare namespace Electron {
8747
8734
  */
8748
8735
  segments: SegmentedControlSegment[];
8749
8736
  /**
8750
- * A `String` representing the controls current segment style. Updating this value
8737
+ * A `string` representing the controls current segment style. Updating this value
8751
8738
  * immediately updates the control in the touch bar.
8752
8739
  */
8753
8740
  segmentStyle: string;
@@ -8768,22 +8755,22 @@ declare namespace Electron {
8768
8755
  */
8769
8756
  constructor(options: TouchBarSliderConstructorOptions);
8770
8757
  /**
8771
- * A `String` representing the slider's current text. Changing this value
8758
+ * A `string` representing the slider's current text. Changing this value
8772
8759
  * immediately updates the slider in the touch bar.
8773
8760
  */
8774
8761
  label: string;
8775
8762
  /**
8776
- * A `Number` representing the slider's current maximum value. Changing this value
8763
+ * A `number` representing the slider's current maximum value. Changing this value
8777
8764
  * immediately updates the slider in the touch bar.
8778
8765
  */
8779
8766
  maxValue: number;
8780
8767
  /**
8781
- * A `Number` representing the slider's current minimum value. Changing this value
8768
+ * A `number` representing the slider's current minimum value. Changing this value
8782
8769
  * immediately updates the slider in the touch bar.
8783
8770
  */
8784
8771
  minValue: number;
8785
8772
  /**
8786
- * A `Number` representing the slider's current value. Changing this value
8773
+ * A `number` representing the slider's current value. Changing this value
8787
8774
  * immediately updates the slider in the touch bar.
8788
8775
  */
8789
8776
  value: number;
@@ -8798,7 +8785,7 @@ declare namespace Electron {
8798
8785
  */
8799
8786
  constructor(options: TouchBarSpacerConstructorOptions);
8800
8787
  /**
8801
- * A `String` representing the size of the spacer. Can be `small`, `large` or
8788
+ * A `string` representing the size of the spacer. Can be `small`, `large` or
8802
8789
  * `flexible`.
8803
8790
  */
8804
8791
  size: ('small' | 'large' | 'flexible');
@@ -9684,14 +9671,6 @@ declare namespace Electron {
9684
9671
  * coordinates of the custom cursor's hotspot.
9685
9672
  */
9686
9673
  hotspot: Point) => void): this;
9687
- /**
9688
- * Emitted when `desktopCapturer.getSources()` is called in the renderer process.
9689
- * Calling `event.preventDefault()` will make it return empty sources.
9690
- */
9691
- on(event: 'desktop-capturer-get-sources', listener: (event: Event) => void): this;
9692
- once(event: 'desktop-capturer-get-sources', listener: (event: Event) => void): this;
9693
- addListener(event: 'desktop-capturer-get-sources', listener: (event: Event) => void): this;
9694
- removeListener(event: 'desktop-capturer-get-sources', listener: (event: Event) => void): this;
9695
9674
  /**
9696
9675
  * Emitted when `webContents` is destroyed.
9697
9676
  */
@@ -10836,14 +10815,32 @@ declare namespace Electron {
10836
10815
  * If *offscreen rendering* is enabled returns the current frame rate.
10837
10816
  */
10838
10817
  getFrameRate(): number;
10818
+ /**
10819
+ * The identifier of a WebContents stream. This identifier can be used with
10820
+ * `navigator.mediaDevices.getUserMedia` using a `chromeMediaSource` of `tab`. The
10821
+ * identifier is restricted to the web contents that it is registered to and is
10822
+ * only valid for 10 seconds.
10823
+ */
10824
+ getMediaSourceId(requestWebContents: WebContents): string;
10839
10825
  /**
10840
10826
  * The operating system `pid` of the associated renderer process.
10841
10827
  */
10842
10828
  getOSProcessId(): number;
10843
10829
  /**
10844
10830
  * Get the system printer list.
10831
+ *
10832
+ *
10833
+ * **Deprecated:** Should use the new `contents.getPrintersAsync` API.
10834
+ *
10835
+ * @deprecated
10845
10836
  */
10846
10837
  getPrinters(): PrinterInfo[];
10838
+ /**
10839
+ * Get the system printer list.
10840
+ *
10841
+ * Resolves with a `PrinterInfo[]`
10842
+ */
10843
+ getPrintersAsync(): Promise<Electron.PrinterInfo[]>;
10847
10844
  /**
10848
10845
  * The Chromium internal `pid` of the associated renderer. Can be compared to the
10849
10846
  * `frameProcessId` passed by frame specific navigation events (e.g.
@@ -11286,11 +11283,11 @@ declare namespace Electron {
11286
11283
  */
11287
11284
  unselect(): void;
11288
11285
  /**
11289
- * A `Boolean` property that determines whether this page is muted.
11286
+ * A `boolean` property that determines whether this page is muted.
11290
11287
  */
11291
11288
  audioMuted: boolean;
11292
11289
  /**
11293
- * A `Boolean` property that determines whether or not this WebContents will
11290
+ * A `boolean` property that determines whether or not this WebContents will
11294
11291
  * throttle animations and timers when the page becomes backgrounded. This also
11295
11292
  * affects the Page Visibility API.
11296
11293
  */
@@ -11339,17 +11336,17 @@ declare namespace Electron {
11339
11336
  */
11340
11337
  readonly session: Session;
11341
11338
  /**
11342
- * A `String` property that determines the user agent for this web page.
11339
+ * A `string` property that determines the user agent for this web page.
11343
11340
  */
11344
11341
  userAgent: string;
11345
11342
  /**
11346
- * A `Number` property that determines the zoom factor for this web contents.
11343
+ * A `number` property that determines the zoom factor for this web contents.
11347
11344
  *
11348
11345
  * The zoom factor is the zoom percent divided by 100, so 300% = 3.0.
11349
11346
  */
11350
11347
  zoomFactor: number;
11351
11348
  /**
11352
- * A `Number` property that determines the zoom level for this web contents.
11349
+ * A `number` property that determines the zoom level for this web contents.
11353
11350
  *
11354
11351
  * The original size is 0 and each increment above or below represents zooming 20%
11355
11352
  * larger or smaller to default limits of 300% and 50% of original size,
@@ -11626,7 +11623,7 @@ declare namespace Electron {
11626
11623
  */
11627
11624
  readonly frameTreeNodeId: number;
11628
11625
  /**
11629
- * A `String` representing the frame name.
11626
+ * A `string` representing the frame name.
11630
11627
  *
11631
11628
  */
11632
11629
  readonly name: string;
@@ -12320,47 +12317,47 @@ declare namespace Electron {
12320
12317
  */
12321
12318
  unselect(): void;
12322
12319
  /**
12323
- * A `Boolean`. When this attribute is present the guest page will be allowed to
12320
+ * A `boolean`. When this attribute is present the guest page will be allowed to
12324
12321
  * open new windows. Popups are disabled by default.
12325
12322
  */
12326
12323
  allowpopups: boolean;
12327
12324
  /**
12328
- * A `String` which is a list of strings which specifies the blink features to be
12325
+ * A `string` which is a list of strings which specifies the blink features to be
12329
12326
  * disabled separated by `,`. The full list of supported feature strings can be
12330
12327
  * found in the RuntimeEnabledFeatures.json5 file.
12331
12328
  */
12332
12329
  disableblinkfeatures: string;
12333
12330
  /**
12334
- * A `Boolean`. When this attribute is present the guest page will have web
12331
+ * A `boolean`. When this attribute is present the guest page will have web
12335
12332
  * security disabled. Web security is enabled by default.
12336
12333
  */
12337
12334
  disablewebsecurity: boolean;
12338
12335
  /**
12339
- * A `String` which is a list of strings which specifies the blink features to be
12336
+ * A `string` which is a list of strings which specifies the blink features to be
12340
12337
  * enabled separated by `,`. The full list of supported feature strings can be
12341
12338
  * found in the RuntimeEnabledFeatures.json5 file.
12342
12339
  */
12343
12340
  enableblinkfeatures: string;
12344
12341
  /**
12345
- * A `String` that sets the referrer URL for the guest page.
12342
+ * A `string` that sets the referrer URL for the guest page.
12346
12343
  */
12347
12344
  httpreferrer: string;
12348
12345
  /**
12349
- * A `Boolean`. When this attribute is present the guest page in `webview` will
12346
+ * A `boolean`. When this attribute is present the guest page in `webview` will
12350
12347
  * have node integration and can use node APIs like `require` and `process` to
12351
12348
  * access low level system resources. Node integration is disabled by default in
12352
12349
  * the guest page.
12353
12350
  */
12354
12351
  nodeintegration: boolean;
12355
12352
  /**
12356
- * A `Boolean` for the experimental option for enabling NodeJS support in
12353
+ * A `boolean` for the experimental option for enabling NodeJS support in
12357
12354
  * sub-frames such as iframes inside the `webview`. All your preloads will load for
12358
12355
  * every iframe, you can use `process.isMainFrame` to determine if you are in the
12359
12356
  * main frame or not. This option is disabled by default in the guest page.
12360
12357
  */
12361
12358
  nodeintegrationinsubframes: boolean;
12362
12359
  /**
12363
- * A `String` that sets the session used by the page. If `partition` starts with
12360
+ * A `string` that sets the session used by the page. If `partition` starts with
12364
12361
  * `persist:`, the page will use a persistent session available to all pages in the
12365
12362
  * app with the same `partition`. if there is no `persist:` prefix, the page will
12366
12363
  * use an in-memory session. By assigning the same `partition`, multiple pages can
@@ -12373,12 +12370,12 @@ declare namespace Electron {
12373
12370
  */
12374
12371
  partition: string;
12375
12372
  /**
12376
- * A `Boolean`. When this attribute is present the guest page in `webview` will be
12373
+ * A `boolean`. When this attribute is present the guest page in `webview` will be
12377
12374
  * able to use browser plugins. Plugins are disabled by default.
12378
12375
  */
12379
12376
  plugins: boolean;
12380
12377
  /**
12381
- * A `String` that specifies a script that will be loaded before other scripts run
12378
+ * A `string` that specifies a script that will be loaded before other scripts run
12382
12379
  * in the guest page. The protocol of script's URL must be `file:` (even when using
12383
12380
  * `asar:` archives) because it will be loaded by Node's `require` under the hood,
12384
12381
  * which treats `asar:` archives as virtual directories.
@@ -12392,7 +12389,7 @@ declare namespace Electron {
12392
12389
  */
12393
12390
  preload: string;
12394
12391
  /**
12395
- * A `String` representing the visible URL. Writing to this attribute initiates
12392
+ * A `string` representing the visible URL. Writing to this attribute initiates
12396
12393
  * top-level navigation.
12397
12394
  *
12398
12395
  * Assigning `src` its own value will reload the current page.
@@ -12402,13 +12399,13 @@ declare namespace Electron {
12402
12399
  */
12403
12400
  src: string;
12404
12401
  /**
12405
- * A `String` that sets the user agent for the guest page before the page is
12402
+ * A `string` that sets the user agent for the guest page before the page is
12406
12403
  * navigated to. Once the page is loaded, use the `setUserAgent` method to change
12407
12404
  * the user agent.
12408
12405
  */
12409
12406
  useragent: string;
12410
12407
  /**
12411
- * A `String` which is a comma separated list of strings which specifies the web
12408
+ * A `string` which is a comma separated list of strings which specifies the web
12412
12409
  * preferences to be set on the webview. The full list of supported preference
12413
12410
  * strings can be found in BrowserWindow.
12414
12411
  *
@@ -15071,7 +15068,7 @@ declare namespace Electron {
15071
15068
 
15072
15069
  interface SourcesOptions {
15073
15070
  /**
15074
- * An array of Strings that lists the types of desktop sources to be captured,
15071
+ * An array of strings that lists the types of desktop sources to be captured,
15075
15072
  * available types are `screen` and `window`.
15076
15073
  */
15077
15074
  types: string[];
@@ -15466,11 +15463,11 @@ declare namespace Electron {
15466
15463
  duplexMode?: ('simplex' | 'shortEdge' | 'longEdge');
15467
15464
  dpi?: Record<string, number>;
15468
15465
  /**
15469
- * String to be printed as page header.
15466
+ * string to be printed as page header.
15470
15467
  */
15471
15468
  header?: string;
15472
15469
  /**
15473
- * String to be printed as page footer.
15470
+ * string to be printed as page footer.
15474
15471
  */
15475
15472
  footer?: string;
15476
15473
  /**
@@ -15531,11 +15528,11 @@ declare namespace Electron {
15531
15528
  duplexMode?: ('simplex' | 'shortEdge' | 'longEdge');
15532
15529
  dpi?: Record<string, number>;
15533
15530
  /**
15534
- * String to be printed as page header.
15531
+ * string to be printed as page header.
15535
15532
  */
15536
15533
  header?: string;
15537
15534
  /**
15538
- * String to be printed as page footer.
15535
+ * string to be printed as page footer.
15539
15536
  */
15540
15537
  footer?: string;
15541
15538
  /**
@@ -16169,8 +16166,6 @@ declare namespace Electron {
16169
16166
  type Clipboard = Electron.Clipboard;
16170
16167
  const crashReporter: CrashReporter;
16171
16168
  type CrashReporter = Electron.CrashReporter;
16172
- const desktopCapturer: DesktopCapturer;
16173
- type DesktopCapturer = Electron.DesktopCapturer;
16174
16169
  const nativeImage: typeof NativeImage;
16175
16170
  type NativeImage = Electron.NativeImage;
16176
16171
  const shell: Shell;
@@ -16407,6 +16402,8 @@ declare namespace Electron {
16407
16402
  type ContentTracing = Electron.ContentTracing;
16408
16403
  type Cookies = Electron.Cookies;
16409
16404
  type Debugger = Electron.Debugger;
16405
+ const desktopCapturer: DesktopCapturer;
16406
+ type DesktopCapturer = Electron.DesktopCapturer;
16410
16407
  const dialog: Dialog;
16411
16408
  type Dialog = Electron.Dialog;
16412
16409
  type Dock = Electron.Dock;
@@ -17334,7 +17331,7 @@ declare namespace NodeJS {
17334
17331
  * * `heapSizeLimit` Integer
17335
17332
  * * `mallocedMemory` Integer
17336
17333
  * * `peakMallocedMemory` Integer
17337
- * * `doesZapGarbage` Boolean
17334
+ * * `doesZapGarbage` boolean
17338
17335
  *
17339
17336
  * Returns an object with V8 heap statistics. Note that all statistics are reported
17340
17337
  * in Kilobytes.
@@ -17396,12 +17393,12 @@ declare namespace NodeJS {
17396
17393
  */
17397
17394
  takeHeapSnapshot(filePath: string): boolean;
17398
17395
  /**
17399
- * A `String` representing Chrome's version string.
17396
+ * A `string` representing Chrome's version string.
17400
17397
  *
17401
17398
  */
17402
17399
  readonly chrome: string;
17403
17400
  /**
17404
- * A `String` (optional) representing a globally unique ID of the current
17401
+ * A `string` (optional) representing a globally unique ID of the current
17405
17402
  * JavaScript context. Each frame has its own JavaScript context. When
17406
17403
  * contextIsolation is enabled, the isolated world also has a separate JavaScript
17407
17404
  * context. This property is only available in the renderer process.
@@ -17409,79 +17406,79 @@ declare namespace NodeJS {
17409
17406
  */
17410
17407
  readonly contextId?: string;
17411
17408
  /**
17412
- * A `Boolean` that indicates whether the current renderer context has
17409
+ * A `boolean` that indicates whether the current renderer context has
17413
17410
  * `contextIsolation` enabled. It is `undefined` in the main process.
17414
17411
  *
17415
17412
  */
17416
17413
  readonly contextIsolated: boolean;
17417
17414
  /**
17418
- * A `Boolean`. When app is started by being passed as parameter to the default
17415
+ * A `boolean`. When app is started by being passed as parameter to the default
17419
17416
  * app, this property is `true` in the main process, otherwise it is `undefined`.
17420
17417
  *
17421
17418
  */
17422
17419
  readonly defaultApp: boolean;
17423
17420
  /**
17424
- * A `String` representing Electron's version string.
17421
+ * A `string` representing Electron's version string.
17425
17422
  *
17426
17423
  */
17427
17424
  readonly electron: string;
17428
17425
  /**
17429
- * A `Boolean`, `true` when the current renderer context is the "main" renderer
17426
+ * A `boolean`, `true` when the current renderer context is the "main" renderer
17430
17427
  * frame. If you want the ID of the current frame you should use
17431
17428
  * `webFrame.routingId`.
17432
17429
  *
17433
17430
  */
17434
17431
  readonly isMainFrame: boolean;
17435
17432
  /**
17436
- * A `Boolean`. For Mac App Store build, this property is `true`, for other builds
17433
+ * A `boolean`. For Mac App Store build, this property is `true`, for other builds
17437
17434
  * it is `undefined`.
17438
17435
  *
17439
17436
  */
17440
17437
  readonly mas: boolean;
17441
17438
  /**
17442
- * A `Boolean` that controls ASAR support inside your application. Setting this to
17439
+ * A `boolean` that controls ASAR support inside your application. Setting this to
17443
17440
  * `true` will disable the support for `asar` archives in Node's built-in modules.
17444
17441
  */
17445
17442
  noAsar: boolean;
17446
17443
  /**
17447
- * A `Boolean` that controls whether or not deprecation warnings are printed to
17444
+ * A `boolean` that controls whether or not deprecation warnings are printed to
17448
17445
  * `stderr`. Setting this to `true` will silence deprecation warnings. This
17449
17446
  * property is used instead of the `--no-deprecation` command line flag.
17450
17447
  */
17451
17448
  noDeprecation: boolean;
17452
17449
  /**
17453
- * A `String` representing the path to the resources directory.
17450
+ * A `string` representing the path to the resources directory.
17454
17451
  *
17455
17452
  */
17456
17453
  readonly resourcesPath: string;
17457
17454
  /**
17458
- * A `Boolean`. When the renderer process is sandboxed, this property is `true`,
17455
+ * A `boolean`. When the renderer process is sandboxed, this property is `true`,
17459
17456
  * otherwise it is `undefined`.
17460
17457
  *
17461
17458
  */
17462
17459
  readonly sandboxed: boolean;
17463
17460
  /**
17464
- * A `Boolean` that controls whether or not deprecation warnings will be thrown as
17461
+ * A `boolean` that controls whether or not deprecation warnings will be thrown as
17465
17462
  * exceptions. Setting this to `true` will throw errors for deprecations. This
17466
17463
  * property is used instead of the `--throw-deprecation` command line flag.
17467
17464
  */
17468
17465
  throwDeprecation: boolean;
17469
17466
  /**
17470
- * A `Boolean` that controls whether or not deprecations printed to `stderr`
17467
+ * A `boolean` that controls whether or not deprecations printed to `stderr`
17471
17468
  * include their stack trace. Setting this to `true` will print stack traces for
17472
17469
  * deprecations. This property is instead of the `--trace-deprecation` command line
17473
17470
  * flag.
17474
17471
  */
17475
17472
  traceDeprecation: boolean;
17476
17473
  /**
17477
- * A `Boolean` that controls whether or not process warnings printed to `stderr`
17474
+ * A `boolean` that controls whether or not process warnings printed to `stderr`
17478
17475
  * include their stack trace. Setting this to `true` will print stack traces for
17479
17476
  * process warnings (including deprecations). This property is instead of the
17480
17477
  * `--trace-warnings` command line flag.
17481
17478
  */
17482
17479
  traceProcessWarnings: boolean;
17483
17480
  /**
17484
- * A `String` representing the current process's type, can be:
17481
+ * A `string` representing the current process's type, can be:
17485
17482
  *
17486
17483
  * * `browser` - The main process
17487
17484
  * * `renderer` - A renderer process
@@ -17490,7 +17487,7 @@ declare namespace NodeJS {
17490
17487
  */
17491
17488
  readonly type: ('browser' | 'renderer' | 'worker');
17492
17489
  /**
17493
- * A `Boolean`. If the app is running as a Windows Store app (appx), this property
17490
+ * A `boolean`. If the app is running as a Windows Store app (appx), this property
17494
17491
  * is `true`, for otherwise it is `undefined`.
17495
17492
  *
17496
17493
  */