Skip to content

Instantly share code, notes, and snippets.

@MarshallOfSound

MarshallOfSound/electron.diff.d.ts.patch Secret

Created May 1, 2019 21:36
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save MarshallOfSound/14fdce4022c3453eeb24c7520f0c8356 to your computer and use it in GitHub Desktop.
Save MarshallOfSound/14fdce4022c3453eeb24c7520f0c8356 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
electron.diff.d.ts.patch
--- a/electron.old.d.ts
+++ b/electron.new.d.ts
@@ -1,4 +1,4 @@
// Project: http://electronjs.org/
// Definitions by: The Electron Team <https://github.com/electron/electron>
// Definitions: https://github.com/electron/electron-typescript-definitions
@@ -8,73 +8,67 @@
type GlobalEvent = Event;
declare namespace Electron {
- // TODO: Replace this declaration with NodeJS.EventEmitter
- class EventEmitter {
- addListener(event: string, listener: Function): this;
- on(event: string, listener: Function): this;
- once(event: string, listener: Function): this;
- removeListener(event: string, listener: Function): this;
- removeAllListeners(event?: string): this;
- setMaxListeners(n: number): this;
- getMaxListeners(): number;
- listeners(event: string): Function[];
- emit(event: string, ...args: any[]): boolean;
- listenerCount(type: string): number;
- prependListener(event: string, listener: Function): this;
- prependOnceListener(event: string, listener: Function): this;
- eventNames(): Array<(string | symbol)>;
- }
-
class Accelerator extends String {
}
interface CommonInterface {
- clipboard: Clipboard;
- crashReporter: CrashReporter;
- nativeImage: typeof NativeImage;
- shell: Shell;
- }
-
- interface MainInterface extends CommonInterface {
app: App;
autoUpdater: AutoUpdater;
BrowserView: typeof BrowserView;
+ BrowserWindowProxy: typeof BrowserWindowProxy;
BrowserWindow: typeof BrowserWindow;
ClientRequest: typeof ClientRequest;
+ clipboard: Clipboard;
+ CommandLine: typeof CommandLine;
contentTracing: ContentTracing;
Cookies: typeof Cookies;
+ crashReporter: CrashReporter;
Debugger: typeof Debugger;
+ desktopCapturer: DesktopCapturer;
dialog: Dialog;
+ Dock: typeof Dock;
DownloadItem: typeof DownloadItem;
globalShortcut: GlobalShortcut;
inAppPurchase: InAppPurchase;
IncomingMessage: typeof IncomingMessage;
ipcMain: IpcMain;
- Menu: typeof Menu;
+ ipcRenderer: IpcRenderer;
MenuItem: typeof MenuItem;
- net: Net;
+ Menu: typeof Menu;
+ nativeImage: typeof NativeImage;
netLog: NetLog;
+ net: Net;
Notification: typeof Notification;
powerMonitor: PowerMonitor;
powerSaveBlocker: PowerSaveBlocker;
protocol: Protocol;
+ remote: Remote;
screen: Screen;
session: typeof Session;
+ shell: Shell;
systemPreferences: SystemPreferences;
+ TouchBarButton: typeof TouchBarButton;
+ TouchBarColorPicker: typeof TouchBarColorPicker;
+ TouchBarGroup: typeof TouchBarGroup;
+ TouchBarLabel: typeof TouchBarLabel;
+ TouchBarPopover: typeof TouchBarPopover;
+ TouchBarScrubber: typeof TouchBarScrubber;
+ TouchBarSegmentedControl: typeof TouchBarSegmentedControl;
+ TouchBarSlider: typeof TouchBarSlider;
+ TouchBarSpacer: typeof TouchBarSpacer;
TouchBar: typeof TouchBar;
Tray: typeof Tray;
webContents: typeof WebContents;
+ webFrame: WebFrame;
WebRequest: typeof WebRequest;
+ webviewTag: WebviewTag;
+ }
+
+ interface MainInterface extends CommonInterface {
}
interface RendererInterface extends CommonInterface {
- BrowserWindowProxy: typeof BrowserWindowProxy;
- desktopCapturer: DesktopCapturer;
- ipcRenderer: IpcRenderer;
- remote: Remote;
- webFrame: WebFrame;
- webviewTag: WebviewTag;
}
interface AllElectron extends MainInterface, RendererInterface {}
@@ -92,8 +86,8 @@ declare namespace Electron {
const ipcRenderer: IpcRenderer;
type nativeImage = NativeImage;
const nativeImage: typeof NativeImage;
- const net: Net;
const netLog: NetLog;
+ const net: Net;
const powerMonitor: PowerMonitor;
const powerSaveBlocker: PowerSaveBlocker;
const protocol: Protocol;
@@ -108,7 +102,7 @@ declare namespace Electron {
const webFrame: WebFrame;
const webviewTag: WebviewTag;
- interface App extends EventEmitter {
+ interface App extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/app
@@ -158,7 +152,7 @@ declare namespace Electron {
*/
on(event: 'activity-was-continued', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -167,7 +161,7 @@ declare namespace Electron {
userInfo: any) => void): this;
once(event: 'activity-was-continued', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -176,7 +170,7 @@ declare namespace Electron {
userInfo: any) => void): this;
addListener(event: 'activity-was-continued', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -185,7 +179,7 @@ declare namespace Electron {
userInfo: any) => void): this;
removeListener(event: 'activity-was-continued', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -194,12 +188,15 @@ declare namespace Electron {
userInfo: any) => void): this;
/**
* Emitted before the application starts closing its windows. Calling
- * event.preventDefault() will prevent the default behavior, which is terminating
- * the application. Note: If application quit was initiated by
- * autoUpdater.quitAndInstall(), then before-quit is emitted after emitting close
- * event on all windows and closing them. Note: On Windows, this event will not be
- * emitted if the app is closed due to a shutdown/restart of the system or a user
- * logout.
+ * `event.preventDefault()` will prevent the default behavior, which is terminating
+ * the application.
+ *
+ * **Note:** If application quit was initiated by `autoUpdater.quitAndInstall()`,
+ * then `before-quit` is emitted *after* emitting `close` event on all windows and
+ * closing them.
+ *
+ * **Note:** On Windows, this event will not be emitted if the app is closed due to
+ * a shutdown/restart of the system or a user logout.
*/
on(event: 'before-quit', listener: (event: Event) => void): this;
once(event: 'before-quit', listener: (event: Event) => void): this;
@@ -239,9 +236,9 @@ declare namespace Electron {
removeListener(event: 'browser-window-focus', listener: (event: Event,
window: BrowserWindow) => void): this;
/**
- * Emitted when failed to verify the certificate for url, to trust the certificate
- * you should prevent the default behavior with event.preventDefault() and call
- * callback(true).
+ * Emitted when failed to verify the `certificate` for `url`, to trust the
+ * certificate you should prevent the default behavior with
+ * `event.preventDefault()` and call `callback(true)`.
*/
on(event: 'certificate-error', listener: (event: Event,
webContents: WebContents,
@@ -281,15 +278,17 @@ declare namespace Electron {
callback: (isTrusted: boolean) => void) => void): this;
/**
* Emitted during Handoff when an activity from a different device wants to be
- * resumed. You should call event.preventDefault() if you want to handle this
- * event. A user activity can be continued only in an app that has the same
- * developer Team ID as the activity's source app and that supports the activity's
- * type. Supported activity types are specified in the app's Info.plist under the
- * NSUserActivityTypes key.
+ * resumed. You should call `event.preventDefault()` if you want to handle this
+ * event.
+ *
+ * A user activity can be continued only in an app that has the same developer Team
+ * ID as the activity's source app and that supports the activity's type. Supported
+ * activity types are specified in the app's `Info.plist` under the
+ * `NSUserActivityTypes` key.
*/
on(event: 'continue-activity', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -298,7 +297,7 @@ declare namespace Electron {
userInfo: any) => void): this;
once(event: 'continue-activity', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -307,7 +306,7 @@ declare namespace Electron {
userInfo: any) => void): this;
addListener(event: 'continue-activity', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -316,7 +315,7 @@ declare namespace Electron {
userInfo: any) => void): this;
removeListener(event: 'continue-activity', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -329,7 +328,7 @@ declare namespace Electron {
*/
on(event: 'continue-activity-error', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -338,7 +337,7 @@ declare namespace Electron {
error: string) => void): this;
once(event: 'continue-activity-error', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -347,7 +346,7 @@ declare namespace Electron {
error: string) => void): this;
addListener(event: 'continue-activity-error', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -356,7 +355,7 @@ declare namespace Electron {
error: string) => void): this;
removeListener(event: 'continue-activity-error', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -364,8 +363,9 @@ declare namespace Electron {
*/
error: string) => void): this;
/**
- * Emitted when desktopCapturer.getSources() is called in the renderer process of
- * webContents. Calling event.preventDefault() will make it return empty sources.
+ * Emitted when `desktopCapturer.getSources()` is called in the renderer process of
+ * `webContents`. Calling `event.preventDefault()` will make it return empty
+ * sources.
*/
on(event: 'desktop-capturer-get-sources', listener: (event: Event,
webContents: WebContents) => void): this;
@@ -387,10 +387,11 @@ declare namespace Electron {
removeListener(event: 'gpu-process-crashed', listener: (event: Event,
killed: boolean) => void): this;
/**
- * Emitted when webContents wants to do basic auth. The default behavior is to
- * cancel all authentications. To override this you should prevent the default
- * behavior with event.preventDefault() and call callback(username, password) with
- * the credentials.
+ * Emitted when `webContents` wants to do basic auth.
+ *
+ * The default behavior is to cancel all authentications. To override this you
+ * should prevent the default behavior with `event.preventDefault()` and call
+ * `callback(username, password)` with the credentials.
*/
on(event: 'login', listener: (event: Event,
webContents: WebContents,
@@ -414,21 +415,24 @@ declare namespace Electron {
callback: (username: string, password: string) => void) => void): this;
/**
* Emitted when the user clicks the native macOS new tab button. The new tab button
- * is only visible if the current BrowserWindow has a tabbingIdentifier
+ * is only visible if the current `BrowserWindow` has a `tabbingIdentifier`
*/
on(event: 'new-window-for-tab', listener: (event: Event) => void): this;
once(event: 'new-window-for-tab', listener: (event: Event) => void): this;
addListener(event: 'new-window-for-tab', listener: (event: Event) => void): this;
removeListener(event: 'new-window-for-tab', listener: (event: Event) => void): this;
/**
- * Emitted when the user wants to open a file with the application. The open-file
+ * Emitted when the user wants to open a file with the application. The `open-file`
* event is usually emitted when the application is already open and the OS wants
- * to reuse the application to open the file. open-file is also emitted when a file
- * is dropped onto the dock and the application is not yet running. Make sure to
- * listen for the open-file event very early in your application startup to handle
- * this case (even before the ready event is emitted). You should call
- * event.preventDefault() if you want to handle this event. On Windows, you have to
- * parse process.argv (in the main process) to get the filepath.
+ * to reuse the application to open the file. `open-file` is also emitted when a
+ * file is dropped onto the dock and the application is not yet running. Make sure
+ * to listen for the `open-file` event very early in your application startup to
+ * handle this case (even before the `ready` event is emitted).
+ *
+ * You should call `event.preventDefault()` if you want to handle this event.
+ *
+ * On Windows, you have to parse `process.argv` (in the main process) to get the
+ * filepath.
*/
on(event: 'open-file', listener: (event: Event,
path: string) => void): this;
@@ -440,9 +444,10 @@ declare namespace Electron {
path: string) => void): this;
/**
* Emitted when the user wants to open a URL with the application. Your
- * application's Info.plist file must define the url scheme within the
- * CFBundleURLTypes key, and set NSPrincipalClass to AtomApplication. You should
- * call event.preventDefault() if you want to handle this event.
+ * application's `Info.plist` file must define the url scheme within the
+ * `CFBundleURLTypes` key, and set `NSPrincipalClass` to `AtomApplication`.
+ *
+You should call `event.preventDefault()` if you want to handle this event.
*/
on(event: 'open-url', listener: (event: Event,
url: string) => void): this;
@@ -453,9 +458,10 @@ declare namespace Electron {
removeListener(event: 'open-url', listener: (event: Event,
url: string) => void): this;
/**
- * Emitted when the application is quitting. Note: On Windows, this event will not
- * be emitted if the app is closed due to a shutdown/restart of the system or a
- * user logout.
+ * Emitted when the application is quitting.
+ *
+ * **Note:** On Windows, this event will not be emitted if the app is closed due to
+ * a shutdown/restart of the system or a user logout.
*/
on(event: 'quit', listener: (event: Event,
exitCode: number) => void): this;
@@ -466,19 +472,19 @@ declare namespace Electron {
removeListener(event: 'quit', listener: (event: Event,
exitCode: number) => void): this;
/**
- * Emitted when Electron has finished initializing. On macOS, launchInfo holds the
- * userInfo of the NSUserNotification that was used to open the application, if it
- * was launched from Notification Center. You can call app.isReady() to check if
- * this event has already fired.
+ * Emitted when Electron has finished initializing. On macOS, `launchInfo` holds
+ * the `userInfo` of the `NSUserNotification` that was used to open the
+ * application, if it was launched from Notification Center. You can call
+ * `app.isReady()` to check if this event has already fired.
*/
on(event: 'ready', listener: (launchInfo: any) => void): this;
once(event: 'ready', listener: (launchInfo: any) => void): this;
addListener(event: 'ready', listener: (launchInfo: any) => void): this;
removeListener(event: 'ready', listener: (launchInfo: any) => void): this;
/**
- * Emitted when remote.getBuiltin() is called in the renderer process of
- * webContents. Calling event.preventDefault() will prevent the module from being
- * returned. Custom value can be returned by setting event.returnValue.
+ * Emitted when `remote.getBuiltin()` is called in the renderer process of
+ * `webContents`. Calling `event.preventDefault()` will prevent the module from
+ * being returned. Custom value can be returned by setting `event.returnValue`.
*/
on(event: 'remote-get-builtin', listener: (event: Event,
webContents: WebContents,
@@ -493,9 +499,9 @@ declare namespace Electron {
webContents: WebContents,
moduleName: string) => void): this;
/**
- * Emitted when remote.getCurrentWebContents() is called in the renderer process of
- * webContents. Calling event.preventDefault() will prevent the object from being
- * returned. Custom value can be returned by setting event.returnValue.
+ * Emitted when `remote.getCurrentWebContents()` is called in the renderer process
+ * of `webContents`. Calling `event.preventDefault()` will prevent the object from
+ * being returned. Custom value can be returned by setting `event.returnValue`.
*/
on(event: 'remote-get-current-web-contents', listener: (event: Event,
webContents: WebContents) => void): this;
@@ -506,9 +512,9 @@ declare namespace Electron {
removeListener(event: 'remote-get-current-web-contents', listener: (event: Event,
webContents: WebContents) => void): this;
/**
- * Emitted when remote.getCurrentWindow() is called in the renderer process of
- * webContents. Calling event.preventDefault() will prevent the object from being
- * returned. Custom value can be returned by setting event.returnValue.
+ * Emitted when `remote.getCurrentWindow()` is called in the renderer process of
+ * `webContents`. Calling `event.preventDefault()` will prevent the object from
+ * being returned. Custom value can be returned by setting `event.returnValue`.
*/
on(event: 'remote-get-current-window', listener: (event: Event,
webContents: WebContents) => void): this;
@@ -519,9 +525,9 @@ declare namespace Electron {
removeListener(event: 'remote-get-current-window', listener: (event: Event,
webContents: WebContents) => void): this;
/**
- * Emitted when remote.getGlobal() is called in the renderer process of
- * webContents. Calling event.preventDefault() will prevent the global from being
- * returned. Custom value can be returned by setting event.returnValue.
+ * Emitted when `remote.getGlobal()` is called in the renderer process of
+ * `webContents`. Calling `event.preventDefault()` will prevent the global from
+ * being returned. Custom value can be returned by setting `event.returnValue`.
*/
on(event: 'remote-get-global', listener: (event: Event,
webContents: WebContents,
@@ -536,9 +542,9 @@ declare namespace Electron {
webContents: WebContents,
globalName: string) => void): this;
/**
- * Emitted when <webview>.getWebContents() is called in the renderer process of
- * webContents. Calling event.preventDefault() will prevent the object from being
- * returned. Custom value can be returned by setting event.returnValue.
+ * Emitted when `<webview>.getWebContents()` is called in the renderer process of
+ * `webContents`. Calling `event.preventDefault()` will prevent the object from
+ * being returned. Custom value can be returned by setting `event.returnValue`.
*/
on(event: 'remote-get-guest-web-contents', listener: (event: Event,
webContents: WebContents,
@@ -553,9 +559,9 @@ declare namespace Electron {
webContents: WebContents,
guestWebContents: WebContents) => void): this;
/**
- * Emitted when remote.require() is called in the renderer process of webContents.
- * Calling event.preventDefault() will prevent the module from being returned.
- * Custom value can be returned by setting event.returnValue.
+ * Emitted when `remote.require()` is called in the renderer process of
+ * `webContents`. Calling `event.preventDefault()` will prevent the module from
+ * being returned. Custom value can be returned by setting `event.returnValue`.
*/
on(event: 'remote-require', listener: (event: Event,
webContents: WebContents,
@@ -570,7 +576,7 @@ declare namespace Electron {
webContents: WebContents,
moduleName: string) => void): this;
/**
- * Emitted when the renderer process of webContents crashes or is killed.
+ * Emitted when the renderer process of `webContents` crashes or is killed.
*/
on(event: 'renderer-process-crashed', listener: (event: Event,
webContents: WebContents,
@@ -586,12 +592,16 @@ declare namespace Electron {
killed: boolean) => void): this;
/**
* This event will be emitted inside the primary instance of your application when
- * a second instance has been executed. argv is an Array of the second instance's
- * command line arguments, and workingDirectory is its current working directory.
+ * a second instance has been executed. `argv` is an Array of the second instance's
+ * command line arguments, and `workingDirectory` is its current working directory.
* Usually applications respond to this by making their primary window focused and
- * non-minimized. This event is guaranteed to be emitted after the ready event of
- * app gets emitted. Note: Extra command line arguments might be added by Chromium,
- * such as --original-process-start-time.
+ * non-minimized.
+ *
+ * This event is guaranteed to be emitted after the `ready` event of `app` gets
+ * emitted.
+ *
+ * **Note:** Extra command line arguments might be added by Chromium, such as
+ * `--original-process-start-time`.
*/
on(event: 'second-instance', listener: (event: Event,
/**
@@ -630,10 +640,12 @@ declare namespace Electron {
*/
workingDirectory: string) => void): this;
/**
- * Emitted when a client certificate is requested. The url corresponds to the
- * navigation entry requesting the client certificate and callback can be called
- * with an entry filtered from the list. Using event.preventDefault() prevents the
- * application from using the first certificate from the store.
+ * Emitted when a client certificate is requested.
+ *
+ * The `url` corresponds to the navigation entry requesting the client certificate
+ * and `callback` can be called with an entry filtered from the list. Using
+ * `event.preventDefault()` prevents the application from using the first
+ * certificate from the store.
*/
on(event: 'select-client-certificate', listener: (event: Event,
webContents: WebContents,
@@ -656,7 +668,7 @@ declare namespace Electron {
certificateList: Certificate[],
callback: (certificate?: Certificate) => void) => void): this;
/**
- * Emitted when Electron has created a new session.
+ * Emitted when Electron has created a new `session`.
*/
on(event: 'session-created', listener: (session: Session) => void): this;
once(event: 'session-created', listener: (session: Session) => void): this;
@@ -664,14 +676,14 @@ declare namespace Electron {
removeListener(event: 'session-created', listener: (session: Session) => void): this;
/**
* Emitted when Handoff is about to be resumed on another device. If you need to
- * update the state to be transferred, you should call event.preventDefault()
- * immediately, construct a new userInfo dictionary and call
- * app.updateCurrentActiviy() in a timely manner. Otherwise, the operation will
- * fail and continue-activity-error will be called.
+ * update the state to be transferred, you should call `event.preventDefault()`
+ * immediately, construct a new `userInfo` dictionary and call
+ * `app.updateCurrentActiviy()` in a timely manner. Otherwise, the operation will
+ * fail and `continue-activity-error` will be called.
*/
on(event: 'update-activity-state', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -680,7 +692,7 @@ declare namespace Electron {
userInfo: any) => void): this;
once(event: 'update-activity-state', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -689,7 +701,7 @@ declare namespace Electron {
userInfo: any) => void): this;
addListener(event: 'update-activity-state', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -698,7 +710,7 @@ declare namespace Electron {
userInfo: any) => void): this;
removeListener(event: 'update-activity-state', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string,
/**
@@ -718,36 +730,37 @@ declare namespace Electron {
webContents: WebContents) => void): this;
/**
* Emitted during Handoff before an activity from a different device wants to be
- * resumed. You should call event.preventDefault() if you want to handle this
+ * resumed. You should call `event.preventDefault()` if you want to handle this
* event.
*/
on(event: 'will-continue-activity', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string) => void): this;
once(event: 'will-continue-activity', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string) => void): this;
addListener(event: 'will-continue-activity', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string) => void): this;
removeListener(event: 'will-continue-activity', listener: (event: Event,
/**
- * A string identifying the activity. Maps to .
+ * A string identifying the activity. Maps to `NSUserActivity.activityType`.
*/
type: string) => void): this;
/**
* Emitted when the application has finished basic startup. On Windows and Linux,
- * the will-finish-launching event is the same as the ready event; on macOS, this
- * event represents the applicationWillFinishLaunching notification of
- * NSApplication. You would usually set up listeners for the open-file and open-url
- * events here, and start the crash reporter and auto updater. In most cases, you
- * should do everything in the ready event handler.
+ * the `will-finish-launching` event is the same as the `ready` event; on macOS,
+ * this event represents the `applicationWillFinishLaunching` notification of
+ * `NSApplication`. You would usually set up listeners for the `open-file` and
+ * `open-url` events here, and start the crash reporter and auto updater.
+ *
+In most cases, you should do everything in the `ready` event handler.
*/
on(event: 'will-finish-launching', listener: Function): this;
once(event: 'will-finish-launching', listener: Function): this;
@@ -755,32 +768,38 @@ declare namespace Electron {
removeListener(event: 'will-finish-launching', listener: Function): this;
/**
* Emitted when all windows have been closed and the application will quit. Calling
- * event.preventDefault() will prevent the default behaviour, which is terminating
- * the application. See the description of the window-all-closed event for the
- * differences between the will-quit and window-all-closed events. Note: On
- * Windows, this event will not be emitted if the app is closed due to a
- * shutdown/restart of the system or a user logout.
+ * `event.preventDefault()` will prevent the default behaviour, which is
+ * terminating the application.
+ *
+ * See the description of the `window-all-closed` event for the differences between
+ * the `will-quit` and `window-all-closed` events.
+ *
+ * **Note:** On Windows, this event will not be emitted if the app is closed due to
+ * a shutdown/restart of the system or a user logout.
*/
on(event: 'will-quit', listener: (event: Event) => void): this;
once(event: 'will-quit', listener: (event: Event) => void): this;
addListener(event: 'will-quit', listener: (event: Event) => void): this;
removeListener(event: 'will-quit', listener: (event: Event) => void): this;
/**
- * Emitted when all windows have been closed. If you do not subscribe to this event
- * and all windows are closed, the default behavior is to quit the app; however, if
- * you subscribe, you control whether the app quits or not. If the user pressed Cmd
- * + Q, or the developer called app.quit(), Electron will first try to close all
- * the windows and then emit the will-quit event, and in this case the
- * window-all-closed event would not be emitted.
+ * Emitted when all windows have been closed.
+ *
+ * If you do not subscribe to this event and all windows are closed, the default
+ * behavior is to quit the app; however, if you subscribe, you control whether the
+ * app quits or not. If the user pressed `Cmd + Q`, or the developer called
+ * `app.quit()`, Electron will first try to close all the windows and then emit the
+ * `will-quit` event, and in this case the `window-all-closed` event would not be
+ * emitted.
*/
on(event: 'window-all-closed', listener: Function): this;
once(event: 'window-all-closed', listener: Function): this;
addListener(event: 'window-all-closed', listener: Function): this;
removeListener(event: 'window-all-closed', listener: Function): this;
/**
- * Adds path to the recent documents list. This list is managed by the OS. On
- * Windows, you can visit the list from the task bar, and on macOS, you can visit
- * it from dock menu.
+ * Adds `path` to the recent documents list.
+ *
+ * This list is managed by the OS. On Windows, you can visit the list from the task
+ * bar, and on macOS, you can visit it from dock menu.
*/
addRecentDocument(path: string): void;
/**
@@ -790,23 +809,28 @@ declare namespace Electron {
/**
* By default, Chromium disables 3D APIs (e.g. WebGL) until restart on a per domain
* basis if the GPU processes crashes too frequently. This function disables that
- * behaviour. This method can only be called before app is ready.
+ * behaviour.
+
+This method can only be called before app is ready.
*/
disableDomainBlockingFor3DAPIs(): void;
/**
- * Disables hardware acceleration for current app. This method can only be called
- * before app is ready.
+ * Disables hardware acceleration for current app.
+ *
+This method can only be called before app is ready.
*/
disableHardwareAcceleration(): void;
/**
- * Enables full sandbox mode on the app. This method can only be called before app
- * is ready.
+ * Enables full sandbox mode on the app.
+ *
+This method can only be called before app is ready.
*/
enableSandbox(): void;
/**
- * Exits immediately with exitCode. exitCode defaults to 0. All windows will be
- * closed immediately without asking the user, and the before-quit and will-quit
- * events will not be emitted.
+ * Exits immediately with `exitCode`. `exitCode` defaults to 0.
+ *
+ * All windows will be closed immediately without asking the user, and the
+ * `before-quit` and `will-quit` events will not be emitted.
*/
exit(exitCode?: number): void;
/**
@@ -814,61 +838,154 @@ declare namespace Electron {
* the active app. On Windows, focuses on the application's first window.
*/
focus(): void;
+ /**
+ * Array of `ProcessMetric` objects that correspond to memory and cpu usage
+ * statistics of all the processes associated with the app.
+ */
getAppMetrics(): ProcessMetric[];
+ /**
+ * The current application directory.
+ */
getAppPath(): string;
/**
- * Deprecated Soon
+ * The current value displayed in the counter badge.
+
+**Deprecated Soon**
*/
getBadgeCount(): number;
+ /**
+ * The type of the currently running activity.
+ */
getCurrentActivityType(): string;
/**
- * Fetches a path's associated icon. On Windows, there a 2 kinds of icons: On Linux
- * and macOS, icons depend on the application associated with file mime type.
+ * fulfilled with the app's icon, which is a NativeImage.
+ *
+ * Fetches a path's associated icon.
+ *
+ * On _Windows_, there a 2 kinds of icons:
+ *
+ * * Icons associated with certain file extensions, like `.mp3`, `.png`, etc.
+ * * Icons inside the file itself, like `.exe`, `.dll`, `.ico`.
+ *
+ * On _Linux_ and _macOS_, icons depend on the application associated with file
+ * mime type.
*/
getFileIcon(path: string, options?: FileIconOptions): Promise<Electron.NativeImage>;
+ /**
+ * The Graphics Feature Status from `chrome://gpu/`.
+ */
getGPUFeatureStatus(): GPUFeatureStatus;
/**
- * For infoType equal to complete: Promise is fulfilled with Object containing all
- * the GPU Information as in chromium's GPUInfo object. This includes the version
- * and driver information that's shown on chrome://gpu page. For infoType equal to
- * basic: Promise is fulfilled with Object containing fewer attributes than when
- * requested with complete. Here's an example of basic response: Using basic should
- * be preferred if only basic information like vendorId or driverId is needed.
+ * For `infoType` equal to `complete`: Promise is fulfilled with `Object`
+ * containing all the GPU Information as in chromium's GPUInfo object. This
+ * includes the version and driver information that's shown on `chrome://gpu` page.
+ *
+ * For `infoType` equal to `basic`: Promise is fulfilled with `Object` containing
+ * fewer attributes than when requested with `complete`. Here's an example of basic
+ * response:
+ *
+ * Using `basic` should be preferred if only basic information like `vendorId` or
+ * `driverId` is needed.
+ */
+ getGPUInfo(infoType: string): Promise<unknown>;
+ /**
+ * * `minItems` Integer - The minimum number of items that will be shown in the
+ * Jump List (for a more detailed description of this value see the MSDN docs).
+ * * `removedItems` JumpListItem[] - Array of `JumpListItem` objects that
+ * correspond to items that the user has explicitly removed from custom categories
+ * in the Jump List. These items must not be re-added to the Jump List in the
+ * **next** call to `app.setJumpList()`, Windows will not display any custom
+ * category that contains any of the removed items.
*/
- getGPUInfo(infoType: string): Promise<any>;
getJumpListSettings(): JumpListSettings;
/**
+ * The current application locale. Possible return values are documented here.
+ *
* To set the locale, you'll want to use a command line switch at app startup,
- * which may be found here. Note: When distributing your packaged app, you have to
- * also ship the locales folder. Note: On Windows, you have to call it after the
- * ready events gets emitted.
+ * which may be found here.
+ *
+ * **Note:** When distributing your packaged app, you have to also ship the
+ * `locales` folder.
+ *
+ * **Note:** On Windows, you have to call it after the `ready` events gets emitted.
*/
getLocale(): string;
/**
- * Note: When unable to detect locale country code, it returns empty string.
+ * User operating system's locale two-letter ISO 3166 country code. The value is
+ * taken from native OS APIs.
+ *
+**Note:** When unable to detect locale country code, it returns empty string.
*/
getLocaleCountryCode(): string;
/**
- * If you provided path and args options to app.setLoginItemSettings, then you need
- * to pass the same arguments here for openAtLogin to be set correctly.
+ * If you provided `path` and `args` options to `app.setLoginItemSettings`, then
+ * you need to pass the same arguments here for `openAtLogin` to be set correctly.
+ *
+ *
+ * * `openAtLogin` Boolean - `true` if the app is set to open at login.
+ * * `openAsHidden` Boolean _macOS_ - `true` if the app is set to open as hidden at
+ * login. This setting is not available on MAS builds.
+ * * `wasOpenedAtLogin` Boolean _macOS_ - `true` if the app was opened at login
+ * automatically. This setting is not available on MAS builds.
+ * * `wasOpenedAsHidden` Boolean _macOS_ - `true` if the app was opened as a hidden
+ * login item. This indicates that the app should not open any windows at startup.
+ * This setting is not available on MAS builds.
+ * * `restoreState` Boolean _macOS_ - `true` if the app was opened as a login item
+ * that should restore the state from the previous session. This indicates that the
+ * app should restore the windows that were open the last time the app was closed.
+ * This setting is not available on MAS builds.
*/
getLoginItemSettings(options?: LoginItemSettingsOptions): LoginItemSettings;
/**
- * Usually the name field of package.json is a short lowercased name, according to
- * the npm modules spec. You should usually also specify a productName field, which
- * is your application's full capitalized name, and which will be preferred over
- * name by Electron. Deprecated Soon
+ * The current application's name, which is the name in the application's
+ * `package.json` file.
+ *
+ * Usually the `name` field of `package.json` is a short lowercased name, according
+ * to the npm modules spec. You should usually also specify a `productName` field,
+ * which is your application's full capitalized name, and which will be preferred
+ * over `name` by Electron.
+
+**Deprecated Soon**
*/
getName(): string;
/**
+ * A path to a special directory or file associated with `name`. On failure, an
+ * `Error` is thrown.
+ *
* You can request the following paths by the name:
+ *
+ * * `home` User's home directory.
+ * * `appData` Per-user application data directory, which by default points to:
+ * * `%APPDATA%` on Windows
+ * * `$XDG_CONFIG_HOME` or `~/.config` on Linux
+ * * `~/Library/Application Support` on macOS
+ * * `userData` The directory for storing your app's configuration files, which by
+ * default it is the `appData` directory appended with your app's name.
+ * * `temp` Temporary directory.
+ * * `exe` The current executable file.
+ * * `module` The `libchromiumcontent` library.
+ * * `desktop` The current user's Desktop directory.
+ * * `documents` Directory for a user's "My Documents".
+ * * `downloads` Directory for a user's downloads.
+ * * `music` Directory for a user's music.
+ * * `pictures` Directory for a user's pictures.
+ * * `videos` Directory for a user's videos.
+ * * `logs` Directory for your app's log folder.
+ * * `pepperFlashSystemPlugin` Full path to the system version of the Pepper Flash
+ * plugin.
+ */
+ getPath(name: string): ('home' | 'appData' | 'userData' | 'temp' | 'exe' | 'module' | 'desktop' | 'documents' | 'downloads' | 'music' | 'pictures' | 'videos' | 'logs' | 'pepperFlashSystemPlugin');
+ /**
+ * The version of the loaded application. If no version is found in the
+ * application's `package.json` file, the version of the current bundle or
+ * executable is returned.
*/
- getPath(name: string): string;
getVersion(): string;
/**
* This method returns whether or not this instance of your app is currently
* holding the single instance lock. You can request the lock with
- * app.requestSingleInstanceLock() and release with app.releaseSingleInstanceLock()
+ * `app.requestSingleInstanceLock()` and release with
+ * `app.releaseSingleInstanceLock()`
*/
hasSingleInstanceLock(): boolean;
/**
@@ -877,70 +994,109 @@ declare namespace Electron {
hide(): void;
/**
* Imports the certificate in pkcs12 format into the platform certificate store.
- * callback is called with the result of import operation, a value of 0 indicates
- * success while any other value indicates failure according to Chromium
+ * `callback` is called with the `result` of import operation, a value of `0`
+ * indicates success while any other value indicates failure according to Chromium
* net_error_list.
*/
importCertificate(options: ImportCertificateOptions, callback: (result: number) => void): void;
/**
- * Invalidates the current Handoff user activity.
+ * * `type` String - Uniquely identifies the activity. Maps to
+ * `NSUserActivity.activityType`.
+
+Invalidates the current Handoff user activity.
*/
- invalidateCurrentActivity(type: string): void;
+ invalidateCurrentActivity(): void;
/**
- * Deprecated Soon
+ * `true` if Chrome's accessibility support is enabled, `false` otherwise. This API
+ * will return `true` if the use of assistive technologies, such as screen readers,
+ * has been detected. See
+ * https://www.chromium.org/developers/design-documents/accessibility for more
+ * details.
+
+**Deprecated Soon**
*/
isAccessibilitySupportEnabled(): boolean;
/**
* This method checks if the current executable is the default handler for a
* protocol (aka URI scheme). If so, it will return true. Otherwise, it will return
- * false. Note: On macOS, you can use this method to check if the app has been
+ * false.
+ *
+ * **Note:** On macOS, you can use this method to check if the app has been
* registered as the default protocol handler for a protocol. You can also verify
- * this by checking ~/Library/Preferences/com.apple.LaunchServices.plist on the
- * macOS machine. Please refer to Apple's documentation for details. The API uses
- * the Windows Registry and LSCopyDefaultHandlerForURLScheme internally.
+ * this by checking `~/Library/Preferences/com.apple.LaunchServices.plist` on the
+ * macOS machine. Please refer to Apple's documentation for details.
+ *
+ * The API uses the Windows Registry and LSCopyDefaultHandlerForURLScheme
+ * internally.
*/
isDefaultProtocolClient(protocol: string, path?: string, args?: string[]): boolean;
+ /**
+ * whether or not the current OS version allows for native emoji pickers.
+ */
isEmojiPanelSupported(): boolean;
+ /**
+ * Whether the application is currently running from the systems Application
+ * folder. Use in combination with `app.moveToApplicationsFolder()`
+ */
isInApplicationsFolder(): boolean;
+ /**
+ * `true` if Electron has finished initializing, `false` otherwise.
+ */
isReady(): boolean;
+ /**
+ * Whether the current desktop environment is Unity launcher.
+ */
isUnityRunning(): boolean;
/**
+ * Whether the move was successful. Please note that if the move is successful,
+ * your application will quit and relaunch.
+ *
* No confirmation dialog will be presented by default. If you wish to allow the
- * user to confirm the operation, you may do so using the dialog API. NOTE: This
- * method throws errors if anything other than the user causes the move to fail.
- * For instance if the user cancels the authorization dialog, this method returns
- * false. If we fail to perform the copy, then this method will throw an error. The
- * message in the error should be informative and tell you exactly what went wrong
+ * user to confirm the operation, you may do so using the `dialog` API.
+ *
+ * **NOTE:** This method throws errors if anything other than the user causes the
+ * move to fail. For instance if the user cancels the authorization dialog, this
+ * method returns false. If we fail to perform the copy, then this method will
+ * throw an error. The message in the error should be informative and tell you
+ * exactly what went wrong
*/
moveToApplicationsFolder(): boolean;
/**
- * Try to close all windows. The before-quit event will be emitted first. If all
- * windows are successfully closed, the will-quit event will be emitted and by
- * default the application will terminate. This method guarantees that all
- * beforeunload and unload event handlers are correctly executed. It is possible
- * that a window cancels the quitting by returning false in the beforeunload event
- * handler.
+ * Try to close all windows. The `before-quit` event will be emitted first. If all
+ * windows are successfully closed, the `will-quit` event will be emitted and by
+ * default the application will terminate.
+ *
+ * This method guarantees that all `beforeunload` and `unload` event handlers are
+ * correctly executed. It is possible that a window cancels the quitting by
+ * returning `false` in the `beforeunload` event handler.
*/
quit(): void;
/**
- * Relaunches the app when current instance exits. By default, the new instance
- * will use the same working directory and command line arguments with current
- * instance. When args is specified, the args will be passed as command line
- * arguments instead. When execPath is specified, the execPath will be executed for
- * relaunch instead of current app. Note that this method does not quit the app
- * when executed, you have to call app.quit or app.exit after calling app.relaunch
- * to make the app restart. When app.relaunch is called for multiple times,
- * multiple instances will be started after current instance exited. An example of
- * restarting current instance immediately and adding a new command line argument
- * to the new instance:
+ * Relaunches the app when current instance exits.
+ *
+ * By default, the new instance will use the same working directory and command
+ * line arguments with current instance. When `args` is specified, the `args` will
+ * be passed as command line arguments instead. When `execPath` is specified, the
+ * `execPath` will be executed for relaunch instead of current app.
+ *
+ * Note that this method does not quit the app when executed, you have to call
+ * `app.quit` or `app.exit` after calling `app.relaunch` to make the app restart.
+ *
+ * When `app.relaunch` is called for multiple times, multiple instances will be
+ * started after current instance exited.
+ *
+ * An example of restarting current instance immediately and adding a new command
+ * line argument to the new instance:
*/
relaunch(options?: RelaunchOptions): void;
/**
- * Releases all locks that were created by requestSingleInstanceLock. This will
+ * Releases all locks that were created by `requestSingleInstanceLock`. This will
* allow multiple instances of the application to once again run side by side.
*/
releaseSingleInstanceLock(): void;
/**
+ * Whether the call succeeded.
+ *
* This method checks if the current executable as the default handler for a
* protocol (aka URI scheme). If so, it will remove the app as the default handler.
*/
@@ -949,115 +1105,170 @@ declare namespace Electron {
* The return value of this method indicates whether or not this instance of your
* application successfully obtained the lock. If it failed to obtain the lock,
* you can assume that another instance of your application is already running with
- * the lock and exit immediately. I.e. This method returns true if your process is
- * the primary instance of your application and your app should continue loading.
- * It returns false if your process should immediately quit as it has sent its
- * parameters to another instance that has already acquired the lock. On macOS, the
- * system enforces single instance automatically when users try to open a second
- * instance of your app in Finder, and the open-file and open-url events will be
- * emitted for that. However when users start your app in command line, the
- * system's single instance mechanism will be bypassed, and you have to use this
- * method to ensure single instance. An example of activating the window of primary
- * instance when a second instance starts:
+ * the lock and exit immediately.
+ *
+ * I.e. This method returns `true` if your process is the primary instance of your
+ * application and your app should continue loading. It returns `false` if your
+ * process should immediately quit as it has sent its parameters to another
+ * instance that has already acquired the lock.
+ *
+ * On macOS, the system enforces single instance automatically when users try to
+ * open a second instance of your app in Finder, and the `open-file` and `open-url`
+ * events will be emitted for that. However when users start your app in command
+ * line, the system's single instance mechanism will be bypassed, and you have to
+ * use this method to ensure single instance.
+ *
+ * An example of activating the window of primary instance when a second instance
+ * starts:
*/
requestSingleInstanceLock(): boolean;
/**
* Set the about panel options. This will override the values defined in the app's
- * .plist file on MacOS. See the Apple docs for more details. On Linux, values must
- * be set in order to be shown; there are no defaults.
+ * `.plist` file on MacOS. See the Apple docs for more details. On Linux, values
+ * must be set in order to be shown; there are no defaults.
*/
setAboutPanelOptions(options: AboutPanelOptionsOptions): void;
/**
* Manually enables Chrome's accessibility support, allowing to expose
* accessibility switch to users in application settings. See Chromium's
- * accessibility docs for more details. Disabled by default. This API must be
- * called after the ready event is emitted. Note: Rendering accessibility tree can
- * significantly affect the performance of your app. It should not be enabled by
- * default. Deprecated Soon
+ * accessibility docs for more details. Disabled by default.
+ *
+ * This API must be called after the `ready` event is emitted.
+ *
+ * **Note:** Rendering accessibility tree can significantly affect the performance
+ * of your app. It should not be enabled by default.
+
+**Deprecated Soon**
*/
setAccessibilitySupportEnabled(enabled: boolean): void;
/**
* Sets or creates a directory your app's logs which can then be manipulated with
- * app.getPath() or app.setPath(newPath). On macOS, this directory will be set by
- * deafault to /Library/Logs/YourAppName, and on Linux and Windows it will be
- * placed inside your userData directory.
+ * `app.getPath()` or `app.setPath(newPath)`.
+ *
+ * On _macOS_, this directory will be set by deafault to
+ * `/Library/Logs/YourAppName`, and on _Linux_ and _Windows_ it will be placed
+ * inside your `userData` directory.
*/
setAppLogsPath(path?: string): void;
/**
- * Changes the Application User Model ID to id.
+ * Changes the Application User Model ID to `id`.
*/
setAppUserModelId(id: string): void;
/**
+ * Whether the call succeeded.
+ *
* This method sets the current executable as the default handler for a protocol
* (aka URI scheme). It allows you to integrate your app deeper into the operating
- * system. Once registered, all links with your-protocol:// will be opened with the
- * current executable. The whole link, including protocol, will be passed to your
- * application as a parameter. On Windows, you can provide optional parameters
- * path, the path to your executable, and args, an array of arguments to be passed
- * to your executable when it launches. Note: On macOS, you can only register
- * protocols that have been added to your app's info.plist, which can not be
- * modified at runtime. You can however change the file with a simple text editor
- * or script during build time. Please refer to Apple's documentation for details.
- * Note: In a Windows Store environment (when packaged as an appx) this API will
- * return true for all calls but the registry key it sets won't be accessible by
- * other applications. In order to register your Windows Store application as a
- * default protocol handler you must declare the protocol in your manifest. The API
- * uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally.
+ * system. Once registered, all links with `your-protocol://` will be opened with
+ * the current executable. The whole link, including protocol, will be passed to
+ * your application as a parameter.
+ *
+ * On Windows, you can provide optional parameters path, the path to your
+ * executable, and args, an array of arguments to be passed to your executable when
+ * it launches.
+ *
+ * **Note:** On macOS, you can only register protocols that have been added to your
+ * app's `info.plist`, which can not be modified at runtime. You can however change
+ * the file with a simple text editor or script during build time. Please refer to
+ * Apple's documentation for details.
+ *
+ * **Note:** In a Windows Store environment (when packaged as an `appx`) this API
+ * will return `true` for all calls but the registry key it sets won't be
+ * accessible by other applications. In order to register your Windows Store
+ * application as a default protocol handler you must declare the protocol in your
+ * manifest.
+ *
+ * The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme
+ * internally.
*/
setAsDefaultProtocolClient(protocol: string, path?: string, args?: string[]): boolean;
/**
- * Sets the counter badge for current app. Setting the count to 0 will hide the
- * badge. On macOS, it shows on the dock icon. On Linux, it only works for Unity
- * launcher. Note: Unity launcher requires the existence of a .desktop file to
- * work, for more information please read Desktop Environment Integration.
- * Deprecated Soon
+ * Whether the call succeeded.
+ *
+ * Sets the counter badge for current app. Setting the count to `0` will hide the
+ * badge.
+ *
+ * On macOS, it shows on the dock icon. On Linux, it only works for Unity launcher.
+ *
+ * **Note:** Unity launcher requires the existence of a `.desktop` file to work,
+ * for more information please read Desktop Environment Integration.
+ *
+**Deprecated Soon**
*/
setBadgeCount(count: number): boolean;
/**
* Sets or removes a custom Jump List for the application, and returns one of the
- * following strings: If categories is null the previously set custom Jump List (if
- * any) will be replaced by the standard Jump List for the app (managed by
- * Windows). Note: If a JumpListCategory object has neither the type nor the name
- * property set then its type is assumed to be tasks. If the name property is set
- * but the type property is omitted then the type is assumed to be custom. Note:
- * Users can remove items from custom categories, and Windows will not allow a
- * removed item to be added back into a custom category until after the next
- * successful call to app.setJumpList(categories). Any attempt to re-add a removed
- * item to a custom category earlier than that will result in the entire custom
- * category being omitted from the Jump List. The list of removed items can be
- * obtained using app.getJumpListSettings(). Here's a very simple example of
- * creating a custom Jump List:
- */
- setJumpList(categories: JumpListCategory[]): void;
- /**
- * Set the app's login item settings. To work with Electron's autoUpdater on
- * Windows, which uses Squirrel, you'll want to set the launch path to Update.exe,
- * and pass arguments that specify your application name. For example:
+ * following strings:
+ *
+ * * `ok` - Nothing went wrong.
+ * * `error` - One or more errors occurred, enable runtime logging to figure out
+ * the likely cause.
+ * * `invalidSeparatorError` - An attempt was made to add a separator to a custom
+ * category in the Jump List. Separators are only allowed in the standard `Tasks`
+ * category.
+ * * `fileTypeRegistrationError` - An attempt was made to add a file link to the
+ * Jump List for a file type the app isn't registered to handle.
+ * * `customCategoryAccessDeniedError` - Custom categories can't be added to the
+ * Jump List due to user privacy or group policy settings.
+ *
+ * If `categories` is `null` the previously set custom Jump List (if any) will be
+ * replaced by the standard Jump List for the app (managed by Windows).
+ *
+ * **Note:** If a `JumpListCategory` object has neither the `type` nor the `name`
+ * property set then its `type` is assumed to be `tasks`. If the `name` property is
+ * set but the `type` property is omitted then the `type` is assumed to be
+ * `custom`.
+ *
+ * **Note:** Users can remove items from custom categories, and Windows will not
+ * allow a removed item to be added back into a custom category until **after** the
+ * next successful call to `app.setJumpList(categories)`. Any attempt to re-add a
+ * removed item to a custom category earlier than that will result in the entire
+ * custom category being omitted from the Jump List. The list of removed items can
+ * be obtained using `app.getJumpListSettings()`.
+ *
+Here's a very simple example of creating a custom Jump List:
+ */
+ setJumpList(categories: (JumpListCategory[]) | (null)): void;
+ /**
+ * Set the app's login item settings.
+ *
+ * To work with Electron's `autoUpdater` on Windows, which uses Squirrel, you'll
+ * want to set the launch path to Update.exe, and pass arguments that specify your
+ * application name. For example:
*/
setLoginItemSettings(settings: Settings): void;
/**
- * Overrides the current application's name. Deprecated Soon
+ * Overrides the current application's name.
+
+**Deprecated Soon**
*/
setName(name: string): void;
/**
- * Overrides the path to a special directory or file associated with name. If the
- * path specifies a directory that does not exist, the directory will be created by
- * this method. On failure an Error is thrown. You can only override paths of a
- * name defined in app.getPath. By default, web pages' cookies and caches will be
- * stored under the userData directory. If you want to change this location, you
- * have to override the userData path before the ready event of the app module is
- * emitted.
+ * Overrides the `path` to a special directory or file associated with `name`. If
+ * the path specifies a directory that does not exist, the directory will be
+ * created by this method. On failure an `Error` is thrown.
+ *
+ * You can only override paths of a `name` defined in `app.getPath`.
+ *
+ * By default, web pages' cookies and caches will be stored under the `userData`
+ * directory. If you want to change this location, you have to override the
+ * `userData` path before the `ready` event of the `app` module is emitted.
*/
setPath(name: string, path: string): void;
/**
- * Creates an NSUserActivity and sets it as the current activity. The activity is
+ * Creates an `NSUserActivity` and sets it as the current activity. The activity is
* eligible for Handoff to another device afterward.
*/
setUserActivity(type: string, userInfo: any, webpageURL?: string): void;
/**
- * Adds tasks to the Tasks category of the JumpList on Windows. tasks is an array
- * of Task objects. Note: If you'd like to customize the Jump List even more use
- * app.setJumpList(categories) instead.
+ * Adds `tasks` to the Tasks category of the JumpList on Windows.
+ *
+ * `tasks` is an array of `Task` objects.
+ *
+ * Whether the call succeeded.
+ *
+ * **Note:** If you'd like to customize the Jump List even more use
+ * `app.setJumpList(categories)` instead.
*/
setUserTasks(tasks: Task[]): boolean;
/**
@@ -1067,7 +1278,7 @@ declare namespace Electron {
show(): void;
/**
* Show the app's about panel options. These options can be overridden with
- * app.setAboutPanelOptions(options).
+ * `app.setAboutPanelOptions(options)`.
*/
showAboutPanel(): void;
/**
@@ -1075,6 +1286,11 @@ declare namespace Electron {
*/
showEmojiPanel(): void;
/**
+ * This function **must** be called once you have finished accessing the security
+ * scoped file. If you do not remember to stop accessing the bookmark, kernel
+ * resources will be leaked and your app will lose its ability to reach outside the
+ * sandbox completely, until your app is restarted.
+ *
* Start accessing a security scoped resource. With this method Electron
* applications that are packaged for the Mac App Store may reach outside their
* sandbox to access files chosen by the user. See Apple's documentation for a
@@ -1082,64 +1298,86 @@ declare namespace Electron {
*/
startAccessingSecurityScopedResource(bookmarkData: string): Function;
/**
- * Updates the current activity if its type matches type, merging the entries from
- * userInfo into its current userInfo dictionary.
+ * Updates the current activity if its type matches `type`, merging the entries
+ * from `userInfo` into its current `userInfo` dictionary.
*/
updateCurrentActivity(type: string, userInfo: any): void;
+ /**
+ * fulfilled when Electron is initialized. May be used as a convenient alternative
+ * to checking `app.isReady()` and subscribing to the `ready` event if the app is
+ * not ready yet.
+ */
whenReady(): Promise<void>;
/**
- * A Boolean property that's true if Chrome's accessibility support is enabled,
- * false otherwise. This property will be true if the use of assistive
+ * A `Boolean` property that's `true` if Chrome's accessibility support is enabled,
+ * `false` otherwise. This property will be `true` if the use of assistive
* technologies, such as screen readers, has been detected. Setting this property
- * to true manually enables Chrome's accessibility support, allowing developers to
- * expose accessibility switch to users in application settings. See Chromium's
- * accessibility docs for more details. Disabled by default. This API must be
- * called after the ready event is emitted. Note: Rendering accessibility tree can
- * significantly affect the performance of your app. It should not be enabled by
- * default.
+ * to `true` manually enables Chrome's accessibility support, allowing developers
+ * to expose accessibility switch to users in application settings.
+ *
+ * See Chromium's accessibility docs for more details. Disabled by default.
+ *
+ * This API must be called after the `ready` event is emitted.
+ *
+ * **Note:** Rendering accessibility tree can significantly affect the performance
+ * of your app. It should not be enabled by default.
+ */
+ accessibilitySupportEnabled: boolean;
+ /**
+ * A `Menu | null` property that return `Menu` if one has been set and `null`
+ * otherwise. Users can pass a Menu to set this property.
*/
- accessibilitySupportEnabled?: boolean;
+ applicationMenu: (Menu) | (null);
/**
- * A Menu property that return Menu if one has been set and null otherwise. Users
- * can pass a Menu to set this property.
+ * An `Integer` property that returns the badge count for current app. Setting the
+ * count to `0` will hide the badge.
+ *
+ * On macOS, setting this with any nonzero integer shows on the dock icon. On
+ * Linux, this property only works for Unity launcher.
+ *
+ * **Note:** Unity launcher requires the existence of a `.desktop` file to work,
+ * for more information please read Desktop Environment Integration.
*/
- applicationMenu?: Menu;
+ badgeCount: number;
/**
- * An Integer property that returns the badge count for current app. Setting the
- * count to 0 will hide the badge. On macOS, setting this with any nonzero integer
- * shows on the dock icon. On Linux, this property only works for Unity launcher.
- * Note: Unity launcher requires the existence of a .desktop file to work, for more
- * information please read Desktop Environment Integration.
+ * A `CommandLine` object that allows you to read and manipulate the command line
+ * arguments that chromium uses.
*/
- badgeCount?: number;
commandLine: CommandLine;
+ /**
+ * A `Dock` object that allows you to perform actions on your app icon in the users
+ * dock on macOS.
+ */
dock: Dock;
/**
- * A Boolean property that returns true if the app is packaged, false otherwise.
- * For many apps, this property can be used to distinguish development and
- * production environments.
+ * A `Boolean` property that returns `true` if the app is packaged, `false`
+ * otherwise. For many apps, this property can be used to distinguish development
+ * and production environments.
*/
- isPackaged?: boolean;
+ isPackaged: boolean;
/**
- * A String property that indicates the current application's name, which is the
- * name in the application's package.json file. Usually the name field of
- * package.json is a short lowercased name, according to the npm modules spec. You
- * should usually also specify a productName field, which is your application's
- * full capitalized name, and which will be preferred over name by Electron.
+ * A `String` property that indicates the current application's name, which is the
+ * name in the application's `package.json` file.
+ *
+ * Usually the `name` field of `package.json` is a short lowercased name, according
+ * to the npm modules spec. You should usually also specify a `productName` field,
+ * which is your application's full capitalized name, and which will be preferred
+ * over `name` by Electron.
*/
- name?: string;
+ name: string;
}
- interface AutoUpdater extends EventEmitter {
+ interface AutoUpdater extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/auto-updater
/**
- * This event is emitted after a user calls quitAndInstall(). When this API is
- * called, the before-quit event is not emitted before all windows are closed. As a
- * result you should listen to this event if you wish to perform actions before the
- * windows are closed while a process is quitting, as well as listening to
- * before-quit.
+ * This event is emitted after a user calls `quitAndInstall()`.
+ *
+ * When this API is called, the `before-quit` event is not emitted before all
+ * windows are closed. As a result you should listen to this event if you wish to
+ * perform actions before the windows are closed while a process is quitting, as
+ * well as listening to `before-quit`.
*/
on(event: 'before-quit-for-update', listener: Function): this;
once(event: 'before-quit-for-update', listener: Function): this;
@@ -1168,10 +1406,12 @@ declare namespace Electron {
addListener(event: 'update-available', listener: Function): this;
removeListener(event: 'update-available', listener: Function): this;
/**
- * Emitted when an update has been downloaded. On Windows only releaseName is
- * available. Note: It is not strictly necessary to handle this event. A
- * successfully downloaded update will still be applied the next time the
- * application starts.
+ * Emitted when an update has been downloaded.
+ *
+ * On Windows only `releaseName` is available.
+ *
+ * **Note:** It is not strictly necessary to handle this event. A successfully
+ * downloaded update will still be applied the next time the application starts.
*/
on(event: 'update-downloaded', listener: (event: Event,
releaseNotes: string,
@@ -1201,23 +1441,29 @@ declare namespace Electron {
addListener(event: 'update-not-available', listener: Function): this;
removeListener(event: 'update-not-available', listener: Function): this;
/**
- * Asks the server whether there is an update. You must call setFeedURL before
+ * Asks the server whether there is an update. You must call `setFeedURL` before
* using this API.
*/
checkForUpdates(): void;
+ /**
+ * The current update feed URL.
+ */
getFeedURL(): string;
/**
* Restarts the app and installs the update after it has been downloaded. It should
- * only be called after update-downloaded has been emitted. Under the hood calling
- * autoUpdater.quitAndInstall() will close all application windows first, and
- * automatically call app.quit() after all windows have been closed. Note: It is
- * not strictly necessary to call this function to apply an update, as a
- * successfully downloaded update will always be applied the next time the
+ * only be called after `update-downloaded` has been emitted.
+ *
+ * Under the hood calling `autoUpdater.quitAndInstall()` will close all application
+ * windows first, and automatically call `app.quit()` after all windows have been
+ * closed.
+ *
+ * **Note:** It is not strictly necessary to call this function to apply an update,
+ * as a successfully downloaded update will always be applied the next time the
* application starts.
*/
quitAndInstall(): void;
/**
- * Sets the url and initialize the auto updater.
+ * Sets the `url` and initialize the auto updater.
*/
setFeedURL(options: FeedURLOptions): void;
}
@@ -1230,20 +1476,36 @@ declare namespace Electron {
deviceName: string;
}
- class BrowserView extends EventEmitter {
+ class BrowserView extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/browser-view
+ /**
+ * BrowserView
+ */
constructor(options?: BrowserViewConstructorOptions);
+ /**
+ * The view with the given `id`.
+ */
static fromId(id: number): BrowserView;
+ /**
+ * The BrowserView that owns the given `webContents` or `null` if the contents are
+ * not owned by a BrowserView.
+ */
static fromWebContents(webContents: WebContents): (BrowserView) | (null);
+ /**
+ * An array of all opened BrowserViews.
+ */
static getAllViews(): BrowserView[];
/**
- * Force closing the view, the unload and beforeunload events won't be emitted for
- * the web page. After you're done with a view, call this function in order to free
- * memory and other resources as soon as possible.
+ * Force closing the view, the `unload` and `beforeunload` events won't be emitted
+ * for the web page. After you're done with a view, call this function in order to
+ * free memory and other resources as soon as possible.
*/
destroy(): void;
+ /**
+ * Whether the view is destroyed.
+ */
isDestroyed(): boolean;
setAutoResize(options: AutoResizeOptions): void;
setBackgroundColor(color: string): void;
@@ -1255,7 +1517,7 @@ declare namespace Electron {
webContents: WebContents;
}
- class BrowserWindow extends EventEmitter {
+ class BrowserWindow extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/browser-window
@@ -1273,10 +1535,16 @@ declare namespace Electron {
/**
* Emitted when an App Command is invoked. These are typically related to keyboard
* media keys or browser commands, as well as the "Back" button built into some
- * mice on Windows. Commands are lowercased, underscores are replaced with hyphens,
- * and the APPCOMMAND_ prefix is stripped off. e.g. APPCOMMAND_BROWSER_BACKWARD is
- * emitted as browser-backward. The following app commands are explictly supported
- * on Linux:
+ * mice on Windows.
+ *
+ * Commands are lowercased, underscores are replaced with hyphens, and the
+ * `APPCOMMAND_` prefix is stripped off. e.g. `APPCOMMAND_BROWSER_BACKWARD` is
+ * emitted as `browser-backward`.
+ *
+ * The following app commands are explictly supported on Linux:
+ *
+* `browser-backward`
+* `browser-forward`
*/
on(event: 'app-command', listener: (event: Event,
command: string) => void): this;
@@ -1295,15 +1563,19 @@ declare namespace Electron {
removeListener(event: 'blur', listener: Function): this;
/**
* Emitted when the window is going to be closed. It's emitted before the
- * beforeunload and unload event of the DOM. Calling event.preventDefault() will
- * cancel the close. Usually you would want to use the beforeunload handler to
- * decide whether the window should be closed, which will also be called when the
- * window is reloaded. In Electron, returning any value other than undefined would
- * cancel the close. For example: Note: There is a subtle difference between the
- * behaviors of window.onbeforeunload = handler and
- * window.addEventListener('beforeunload', handler). It is recommended to always
- * set the event.returnValue explicitly, instead of only returning a value, as the
- * former works more consistently within Electron.
+ * `beforeunload` and `unload` event of the DOM. Calling `event.preventDefault()`
+ * will cancel the close.
+ *
+ * Usually you would want to use the `beforeunload` handler to decide whether the
+ * window should be closed, which will also be called when the window is reloaded.
+ * In Electron, returning any value other than `undefined` would cancel the close.
+ * For example:
+ *
+ * _**Note**: There is a subtle difference between the behaviors of
+ * `window.onbeforeunload = handler` and `window.addEventListener('beforeunload',
+ * handler)`. It is recommended to always set the `event.returnValue` explicitly,
+ * instead of only returning a value, as the former works more consistently within
+ * Electron._
*/
on(event: 'close', listener: (event: Event) => void): this;
once(event: 'close', listener: (event: Event) => void): this;
@@ -1374,8 +1646,9 @@ declare namespace Electron {
addListener(event: 'minimize', listener: Function): this;
removeListener(event: 'minimize', listener: Function): this;
/**
- * Emitted when the window is being moved to a new position. Note: On macOS this
- * event is an alias of moved.
+ * Emitted when the window is being moved to a new position.
+ *
+__Note__: On macOS this event is an alias of `moved`.
*/
on(event: 'move', listener: Function): this;
once(event: 'move', listener: Function): this;
@@ -1396,8 +1669,8 @@ declare namespace Electron {
addListener(event: 'new-window-for-tab', listener: Function): this;
removeListener(event: 'new-window-for-tab', listener: Function): this;
/**
- * Emitted when the document changed its title, calling event.preventDefault() will
- * prevent the native window's title from changing.
+ * Emitted when the document changed its title, calling `event.preventDefault()`
+ * will prevent the native window's title from changing.
*/
on(event: 'page-title-updated', listener: (event: Event,
title: string) => void): this;
@@ -1487,7 +1760,8 @@ declare namespace Electron {
addListener(event: 'show', listener: Function): this;
removeListener(event: 'show', listener: Function): this;
/**
- * Emitted on 3-finger swipe. Possible directions are up, right, down, left.
+ * Emitted on 3-finger swipe. Possible directions are `up`, `right`, `down`,
+ * `left`.
*/
on(event: 'swipe', listener: (event: Event,
direction: string) => void): this;
@@ -1512,97 +1786,139 @@ declare namespace Electron {
addListener(event: 'unresponsive', listener: Function): this;
removeListener(event: 'unresponsive', listener: Function): this;
/**
- * Emitted before the window is moved. Calling event.preventDefault() will prevent
- * the window from being moved. Note that this is only emitted when the window is
- * being resized manually. Resizing the window with setBounds/setSize will not emit
- * this event.
+ * Emitted before the window is moved. Calling `event.preventDefault()` will
+ * prevent the window from being moved.
+ *
+ * Note that this is only emitted when the window is being resized manually.
+ * Resizing the window with `setBounds`/`setSize` will not emit this event.
*/
on(event: 'will-move', listener: (event: Event,
/**
- * ` Location the window is being moved to.
+ * Location the window is being moved to.
*/
- newBounds: Rectangle) => void): this;
+ newBounds: `Rectangle`) => void): this;
once(event: 'will-move', listener: (event: Event,
/**
- * ` Location the window is being moved to.
+ * Location the window is being moved to.
*/
- newBounds: Rectangle) => void): this;
+ newBounds: `Rectangle`) => void): this;
addListener(event: 'will-move', listener: (event: Event,
/**
- * ` Location the window is being moved to.
+ * Location the window is being moved to.
*/
- newBounds: Rectangle) => void): this;
+ newBounds: `Rectangle`) => void): this;
removeListener(event: 'will-move', listener: (event: Event,
/**
- * ` Location the window is being moved to.
+ * Location the window is being moved to.
*/
- newBounds: Rectangle) => void): this;
+ newBounds: `Rectangle`) => void): this;
/**
- * Emitted before the window is resized. Calling event.preventDefault() will
- * prevent the window from being resized. Note that this is only emitted when the
- * window is being resized manually. Resizing the window with setBounds/setSize
- * will not emit this event.
+ * Emitted before the window is resized. Calling `event.preventDefault()` will
+ * prevent the window from being resized.
+ *
+ * Note that this is only emitted when the window is being resized manually.
+ * Resizing the window with `setBounds`/`setSize` will not emit this event.
*/
on(event: 'will-resize', listener: (event: Event,
/**
- * ` Size the window is being resized to.
+ * Size the window is being resized to.
*/
- newBounds: Rectangle) => void): this;
+ newBounds: `Rectangle`) => void): this;
once(event: 'will-resize', listener: (event: Event,
/**
- * ` Size the window is being resized to.
+ * Size the window is being resized to.
*/
- newBounds: Rectangle) => void): this;
+ newBounds: `Rectangle`) => void): this;
addListener(event: 'will-resize', listener: (event: Event,
/**
- * ` Size the window is being resized to.
+ * Size the window is being resized to.
*/
- newBounds: Rectangle) => void): this;
+ newBounds: `Rectangle`) => void): this;
removeListener(event: 'will-resize', listener: (event: Event,
/**
- * ` Size the window is being resized to.
+ * Size the window is being resized to.
*/
- newBounds: Rectangle) => void): this;
+ newBounds: `Rectangle`) => void): this;
+ /**
+ * BrowserWindow
+ */
constructor(options?: BrowserWindowConstructorOptions);
/**
- * Adds DevTools extension located at path, and returns extension's name. The
- * extension will be remembered so you only need to call this API once, this API is
- * not for programming use. If you try to add an extension that has already been
- * loaded, this method will not return and instead log a warning to the console.
+ * Adds DevTools extension located at `path`, and returns extension's name.
+ *
+ * The extension will be remembered so you only need to call this API once, this
+ * API is not for programming use. If you try to add an extension that has already
+ * been loaded, this method will not return and instead log a warning to the
+ * console.
+ *
* The method will also not return if the extension's manifest is missing or
- * incomplete. Note: This API cannot be called before the ready event of the app
- * module is emitted.
+ * incomplete.
+ *
+ * **Note:** This API cannot be called before the `ready` event of the `app` module
+ * is emitted.
*/
static addDevToolsExtension(path: string): void;
/**
- * Adds Chrome extension located at path, and returns extension's name. The method
- * will also not return if the extension's manifest is missing or incomplete. Note:
- * This API cannot be called before the ready event of the app module is emitted.
+ * Adds Chrome extension located at `path`, and returns extension's name.
+ *
+ * The method will also not return if the extension's manifest is missing or
+ * incomplete.
+ *
+ * **Note:** This API cannot be called before the `ready` event of the `app` module
+ * is emitted.
*/
static addExtension(path: string): void;
+ /**
+ * The window that owns the given `browserView`. If the given view is not attached
+ * to any window, returns `null`.
+ */
static fromBrowserView(browserView: BrowserView): (BrowserWindow) | (null);
+ /**
+ * The window with the given `id`.
+ */
static fromId(id: number): BrowserWindow;
+ /**
+ * The window that owns the given `webContents`.
+ */
static fromWebContents(webContents: WebContents): BrowserWindow;
+ /**
+ * An array of all opened browser windows.
+ */
static getAllWindows(): BrowserWindow[];
/**
- * To check if a DevTools extension is installed you can run the following: Note:
- * This API cannot be called before the ready event of the app module is emitted.
+ * The keys are the extension names and each value is an Object containing `name`
+ * and `version` properties.
+ *
+ * To check if a DevTools extension is installed you can run the following:
+ *
+ * **Note:** This API cannot be called before the `ready` event of the `app` module
+ * is emitted.
*/
static getDevToolsExtensions(): DevToolsExtensions;
/**
- * Note: This API cannot be called before the ready event of the app module is
- * emitted.
+ * The keys are the extension names and each value is an Object containing `name`
+ * and `version` properties.
+ *
+ * **Note:** This API cannot be called before the `ready` event of the `app` module
+ * is emitted.
*/
static getExtensions(): Extensions;
+ /**
+ * The window that is focused in this application, otherwise returns `null`.
+ */
static getFocusedWindow(): (BrowserWindow) | (null);
/**
- * Remove a DevTools extension by name. Note: This API cannot be called before the
- * ready event of the app module is emitted.
+ * Remove a DevTools extension by name.
+ *
+ * **Note:** This API cannot be called before the `ready` event of the `app` module
+ * is emitted.
*/
static removeDevToolsExtension(name: string): void;
/**
- * Remove a Chrome extension by name. Note: This API cannot be called before the
- * ready event of the app module is emitted.
+ * Remove a Chrome extension by name.
+ *
+ * **Note:** This API cannot be called before the `ready` event of the `app` module
+ * is emitted.
*/
static removeExtension(name: string): void;
/**
@@ -1619,7 +1935,9 @@ declare namespace Electron {
blur(): void;
blurWebView(): void;
/**
- * Captures a snapshot of the page within rect. Omitting rect will capture the
+ * Resolves with a NativeImage
+ *
+ * Captures a snapshot of the page within `rect`. Omitting `rect` will capture the
* whole visible page.
*/
capturePage(rect?: Rectangle): Promise<Electron.NativeImage>;
@@ -1638,9 +1956,9 @@ declare namespace Electron {
*/
closeFilePreview(): void;
/**
- * Force closing the window, the unload and beforeunload event won't be emitted for
- * the web page, and close event will also not be emitted for this window, but it
- * guarantees the closed event will be emitted.
+ * Force closing the window, the `unload` and `beforeunload` event won't be emitted
+ * for the web page, and `close` event will also not be emitted for this window,
+ * but it guarantees the `closed` event will be emitted.
*/
destroy(): void;
/**
@@ -1653,42 +1971,83 @@ declare namespace Electron {
focus(): void;
focusOnWebView(): void;
getBounds(): Rectangle;
+ /**
+ * an BrowserView what is attached. Returns `null` if none is attached. Throw error
+ * if multiple BrowserViews is attached.
+ */
getBrowserView(): (BrowserView) | (null);
/**
- * Returns array of BrowserView what was an attached with addBrowserView or
- * setBrowserView. Note: The BrowserView API is currently experimental and may
- * change or be removed in future Electron releases.
+ * Returns array of `BrowserView` what was an attached with addBrowserView or
+ * setBrowserView.
+ *
+ * **Note:** The BrowserView API is currently experimental and may change or be
+ * removed in future Electron releases.
*/
getBrowserViews(): void;
+ /**
+ * All child windows.
+ */
getChildWindows(): BrowserWindow[];
getContentBounds(): Rectangle;
+ /**
+ * Contains the window's client area's width and height.
+ */
getContentSize(): number[];
+ /**
+ * Contains the window's maximum width and height.
+ */
getMaximumSize(): number[];
+ /**
+ * Contains the window's minimum width and height.
+ */
getMinimumSize(): number[];
/**
- * The native type of the handle is HWND on Windows, NSView* on macOS, and Window
- * (unsigned long) on Linux.
+ * The platform-specific handle of the window.
+ *
+ * The native type of the handle is `HWND` on Windows, `NSView*` on macOS, and
+ * `Window` (`unsigned long`) on Linux.
*/
getNativeWindowHandle(): Buffer;
/**
- * Note: whatever the current state of the window : maximized, minimized or in
+ * Contains the window bounds of the normal state
+ *
+ * **Note:** whatever the current state of the window : maximized, minimized or in
* fullscreen, this function always returns the position and size of the window in
* normal state. In normal state, getBounds and getNormalBounds returns the same
- * Rectangle.
+ * `Rectangle`.
*/
getNormalBounds(): Rectangle;
+ /**
+ * between 0.0 (fully transparent) and 1.0 (fully opaque)
+ */
getOpacity(): number;
+ /**
+ * The parent window.
+ */
getParentWindow(): BrowserWindow;
+ /**
+ * Contains the window's current position.
+ */
getPosition(): number[];
+ /**
+ * The pathname of the file the window represents.
+ */
getRepresentedFilename(): string;
+ /**
+ * Contains the window's width and height.
+ */
getSize(): number[];
/**
- * Note: The title of the web page can be different from the title of the native
- * window.
+ * The title of the native window.
+ *
+ * **Note:** The title of the web page can be different from the title of the
+ * native window.
*/
getTitle(): string;
/**
- * On Windows and Linux always returns true.
+ * Whether the window has a shadow.
+
+On Windows and Linux always returns `true`.
*/
hasShadow(): boolean;
/**
@@ -1696,58 +2055,133 @@ declare namespace Electron {
*/
hide(): void;
/**
- * Hooks a windows message. The callback is called when the message is received in
- * the WndProc.
+ * Hooks a windows message. The `callback` is called when the message is received
+ * in the WndProc.
+ */
+ hookWindowMessage(message: number, callback: () => void): void;
+ /**
+ * Whether the window is always on top of other windows.
*/
- hookWindowMessage(message: number, callback: Function): void;
isAlwaysOnTop(): boolean;
/**
- * On Linux always returns true.
+ * Whether the window can be manually closed by user.
+ *
+On Linux always returns `true`.
*/
isClosable(): boolean;
+ /**
+ * Whether the window is destroyed.
+ */
isDestroyed(): boolean;
+ /**
+ * Whether the window's document has been edited.
+ */
isDocumentEdited(): boolean;
+ /**
+ * Whether the window is focused.
+ */
isFocused(): boolean;
+ /**
+ * Whether the window is in fullscreen mode.
+ */
isFullScreen(): boolean;
+ /**
+ * Whether the maximize/zoom window button toggles fullscreen mode or maximizes the
+ * window.
+ */
isFullScreenable(): boolean;
+ /**
+ * Whether the window is in kiosk mode.
+ */
isKiosk(): boolean;
/**
- * On Linux always returns true.
+ * Whether the window can be manually maximized by user.
+ *
+On Linux always returns `true`.
*/
isMaximizable(): boolean;
+ /**
+ * Whether the window is maximized.
+ */
isMaximized(): boolean;
+ /**
+ * Whether menu bar automatically hides itself.
+ */
isMenuBarAutoHide(): boolean;
+ /**
+ * Whether the menu bar is visible.
+ */
isMenuBarVisible(): boolean;
/**
- * On Linux always returns true.
+ * Whether the window can be manually minimized by user
+ *
+On Linux always returns `true`.
*/
isMinimizable(): boolean;
+ /**
+ * Whether the window is minimized.
+ */
isMinimized(): boolean;
+ /**
+ * Whether current window is a modal window.
+ */
isModal(): boolean;
/**
- * On Linux always returns true.
+ * Whether the window can be moved by user.
+
+On Linux always returns `true`.
*/
isMovable(): boolean;
+ /**
+ * Whether the window is in normal state (not maximized, not minimized, not in
+ * fullscreen mode).
+ */
isNormal(): boolean;
+ /**
+ * Whether the window can be manually resized by user.
+ */
isResizable(): boolean;
+ /**
+ * Whether the window is in simple (pre-Lion) fullscreen mode.
+ */
isSimpleFullScreen(): boolean;
+ /**
+ * Whether the window is visible to the user.
+ */
isVisible(): boolean;
/**
- * Note: This API always returns false on Windows.
+ * Whether the window is visible on all workspaces.
+ *
+**Note:** This API always returns false on Windows.
*/
isVisibleOnAllWorkspaces(): boolean;
+ /**
+ * `true` or `false` depending on whether the message is hooked.
+ */
isWindowMessageHooked(message: number): boolean;
/**
- * Same as webContents.loadFile, filePath should be a path to an HTML file relative
- * to the root of your application. See the webContents docs for more information.
+ * the promise will resolve when the page has finished loading (see
+ * `did-finish-load`), and rejects if the page fails to load (see `did-fail-load`).
+ *
+ * Same as `webContents.loadFile`, `filePath` should be a path to an HTML file
+ * relative to the root of your application. See the `webContents` docs for more
+ * information.
*/
loadFile(filePath: string, options?: LoadFileOptions): Promise<void>;
/**
- * Same as webContents.loadURL(url[, options]). The url can be a remote address
- * (e.g. http://) or a path to a local HTML file using the file:// protocol. To
- * ensure that file URLs are properly formatted, it is recommended to use Node's
- * url.format method: You can load a URL using a POST request with URL-encoded data
- * by doing the following:
+ * the promise will resolve when the page has finished loading (see
+ * `did-finish-load`), and rejects if the page fails to load (see `did-fail-load`).
+ *
+ * Same as `webContents.loadURL(url[, options])`.
+ *
+ * The `url` can be a remote address (e.g. `http://`) or a path to a local HTML
+ * file using the `file://` protocol.
+ *
+ * To ensure that file URLs are properly formatted, it is recommended to use Node's
+ * `url.format` method:
+ *
+ * You can load a URL using a `POST` request with URL-encoded data by doing the
+ * following:
*/
loadURL(url: string, options?: LoadURLOptions): Promise<void>;
/**
@@ -1779,7 +2213,7 @@ declare namespace Electron {
*/
previewFile(path: string, displayName?: string): void;
/**
- * Same as webContents.reload.
+ * Same as `webContents.reload`.
*/
reload(): void;
removeBrowserView(browserView: BrowserView): void;
@@ -1808,24 +2242,28 @@ declare namespace Electron {
*/
setAlwaysOnTop(flag: boolean, level?: 'normal' | 'floating' | 'torn-off-menu' | 'modal-panel' | 'main-menu' | 'status' | 'pop-up-menu' | 'screen-saver', relativeLevel?: number): void;
/**
- * Sets the properties for the window's taskbar button. Note: relaunchCommand and
- * relaunchDisplayName must always be set together. If one of those properties is
- * not set, then neither will be used.
+ * Sets the properties for the window's taskbar button.
+ *
+ * **Note:** `relaunchCommand` and `relaunchDisplayName` must always be set
+ * together. If one of those properties is not set, then neither will be used.
*/
setAppDetails(options: AppDetailsOptions): void;
/**
* This will make a window maintain an aspect ratio. The extra size allows a
* developer to have space, specified in pixels, not included within the aspect
* ratio calculations. This API already takes into account the difference between a
- * window's size and its content size. Consider a normal window with an HD video
- * player and associated controls. Perhaps there are 15 pixels of controls on the
- * left edge, 25 pixels of controls on the right edge and 50 pixels of controls
- * below the player. In order to maintain a 16:9 aspect ratio (standard aspect
- * ratio for HD @1920x1080) within the player itself we would call this function
- * with arguments of 16/9 and [ 40, 50 ]. The second argument doesn't care where
- * the extra width and height are within the content view--only that they exist.
- * Sum any extra width and height areas you have within the overall content view.
- * Calling this function with a value of 0 will remove any previously set aspect
+ * window's size and its content size.
+ *
+ * Consider a normal window with an HD video player and associated controls.
+ * Perhaps there are 15 pixels of controls on the left edge, 25 pixels of controls
+ * on the right edge and 50 pixels of controls below the player. In order to
+ * maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080) within
+ * the player itself we would call this function with arguments of 16/9 and [ 40,
+ * 50 ]. The second argument doesn't care where the extra width and height are
+ * within the content view--only that they exist. Sum any extra width and height
+ * areas you have within the overall content view.
+ *
+ * Calling this function with a value of `0` will remove any previously set aspect
* ratios.
*/
setAspectRatio(aspectRatio: number, extraSize: Size): void;
@@ -1835,12 +2273,14 @@ declare namespace Electron {
setAutoHideCursor(autoHide: boolean): void;
/**
* Sets whether the window menu bar should hide itself automatically. Once set the
- * menu bar will only show when users press the single Alt key. If the menu bar is
- * already visible, calling setAutoHideMenuBar(true) won't hide it immediately.
+ * menu bar will only show when users press the single `Alt` key.
+ *
+ * If the menu bar is already visible, calling `setAutoHideMenuBar(true)` won't
+ * hide it immediately.
*/
setAutoHideMenuBar(hide: boolean): void;
/**
- * Sets the background color of the window. See Setting backgroundColor.
+ * Sets the background color of the window. See Setting `backgroundColor`.
*/
setBackgroundColor(backgroundColor: string): void;
/**
@@ -1859,18 +2299,19 @@ declare namespace Electron {
*/
setContentBounds(bounds: Rectangle, animate?: boolean): void;
/**
- * Prevents the window contents from being captured by other apps. On macOS it sets
- * the NSWindow's sharingType to NSWindowSharingNone. On Windows it calls
- * SetWindowDisplayAffinity with WDA_MONITOR.
+ * Prevents the window contents from being captured by other apps.
+ *
+ * On macOS it sets the NSWindow's sharingType to NSWindowSharingNone. On Windows
+ * it calls SetWindowDisplayAffinity with `WDA_MONITOR`.
*/
setContentProtection(enable: boolean): void;
/**
- * Resizes the window's client area (e.g. the web page) to width and height.
+ * Resizes the window's client area (e.g. the web page) to `width` and `height`.
*/
setContentSize(width: number, height: number, animate?: boolean): void;
/**
* Specifies whether the window’s document has been edited, and the icon in title
- * bar will become gray when set to true.
+ * bar will become gray when set to `true`.
*/
setDocumentEdited(edited: boolean): void;
/**
@@ -1899,9 +2340,10 @@ declare namespace Electron {
*/
setIcon(icon: NativeImage): void;
/**
- * Makes the window ignore all mouse events. All mouse events happened in this
- * window will be passed to the window below this window, but if this window has
- * focus, it will still receive keyboard events.
+ * Makes the window ignore all mouse events.
+ *
+ * All mouse events happened in this window will be passed to the window below this
+ * window, but if this window has focus, it will still receive keyboard events.
*/
setIgnoreMouseEvents(ignore: boolean, options?: IgnoreMouseEventsOptions): void;
/**
@@ -1914,16 +2356,16 @@ declare namespace Electron {
*/
setMaximizable(maximizable: boolean): void;
/**
- * Sets the maximum size of window to width and height.
+ * Sets the maximum size of window to `width` and `height`.
*/
setMaximumSize(width: number, height: number): void;
/**
- * Sets the menu as the window's menu bar.
+ * Sets the `menu` as the window's menu bar.
*/
setMenu(menu: (Menu) | (null)): void;
/**
* Sets whether the menu bar should be visible. If the menu bar is auto-hide, users
- * can still bring up the menu bar by pressing the single Alt key.
+ * can still bring up the menu bar by pressing the single `Alt` key.
*/
setMenuBarVisibility(visible: boolean): void;
/**
@@ -1932,7 +2374,7 @@ declare namespace Electron {
*/
setMinimizable(minimizable: boolean): void;
/**
- * Sets the minimum size of window to width and height.
+ * Sets the minimum size of window to `width` and `height`.
*/
setMinimumSize(width: number, height: number): void;
/**
@@ -1949,23 +2391,27 @@ declare namespace Electron {
*/
setOverlayIcon(overlay: (NativeImage) | (null), description: string): void;
/**
- * Sets parent as current window's parent window, passing null will turn current
- * window into a top-level window.
+ * Sets `parent` as current window's parent window, passing `null` will turn
+ * current window into a top-level window.
*/
setParentWindow(parent: BrowserWindow): void;
/**
- * Moves window to x and y.
+ * Moves window to `x` and `y`.
*/
setPosition(x: number, y: number, animate?: boolean): void;
/**
- * Sets progress value in progress bar. Valid range is [0, 1.0]. Remove progress
- * bar when progress < 0; Change to indeterminate mode when progress > 1. On Linux
- * platform, only supports Unity desktop environment, you need to specify the
- * *.desktop file name to desktopName field in package.json. By default, it will
- * assume {app.name}.desktop. On Windows, a mode can be passed. Accepted values are
- * none, normal, indeterminate, error, and paused. If you call setProgressBar
- * without a mode set (but with a value within the valid range), normal will be
- * assumed.
+ * Sets progress value in progress bar. Valid range is [0, 1.0].
+ *
+ * Remove progress bar when progress < 0; Change to indeterminate mode when
+ * progress > 1.
+ *
+ * On Linux platform, only supports Unity desktop environment, you need to specify
+ * the `*.desktop` file name to `desktopName` field in `package.json`. By default,
+ * it will assume `{app.name}.desktop`.
+ *
+ * On Windows, a mode can be passed. Accepted values are `none`, `normal`,
+ * `indeterminate`, `error`, and `paused`. If you call `setProgressBar` without a
+ * mode set (but with a value within the valid range), `normal` will be assumed.
*/
setProgressBar(progress: number, options?: ProgressBarOptions): void;
/**
@@ -1992,13 +2438,15 @@ declare namespace Electron {
*/
setSheetOffset(offsetY: number, offsetX?: number): void;
/**
- * Enters or leaves simple fullscreen mode. Simple fullscreen mode emulates the
- * native fullscreen behavior found in versions of Mac OS X prior to Lion (10.7).
+ * Enters or leaves simple fullscreen mode.
+ *
+ * Simple fullscreen mode emulates the native fullscreen behavior found in versions
+ * of Mac OS X prior to Lion (10.7).
*/
setSimpleFullScreen(flag: boolean): void;
/**
- * Resizes the window to width and height. If width or height are below any set
- * minimum size constraints the window will snap to its minimum size.
+ * Resizes the window to `width` and `height`. If `width` or `height` are below any
+ * set minimum size constraints the window will snap to its minimum size.
*/
setSize(width: number, height: number, animate?: boolean): void;
/**
@@ -2006,21 +2454,45 @@ declare namespace Electron {
*/
setSkipTaskbar(skip: boolean): void;
/**
+ * Whether the buttons were added successfully
+ *
* Add a thumbnail toolbar with a specified set of buttons to the thumbnail image
- * of a window in a taskbar button layout. Returns a Boolean object indicates
- * whether the thumbnail has been added successfully. The number of buttons in
- * thumbnail toolbar should be no greater than 7 due to the limited room. Once you
- * setup the thumbnail toolbar, the toolbar cannot be removed due to the platform's
- * limitation. But you can call the API with an empty array to clean the buttons.
- * The buttons is an array of Button objects: The flags is an array that can
- * include following Strings:
+ * of a window in a taskbar button layout. Returns a `Boolean` object indicates
+ * whether the thumbnail has been added successfully.
+ *
+ * The number of buttons in thumbnail toolbar should be no greater than 7 due to
+ * the limited room. Once you setup the thumbnail toolbar, the toolbar cannot be
+ * removed due to the platform's limitation. But you can call the API with an empty
+ * array to clean the buttons.
+ *
+ * The `buttons` is an array of `Button` objects:
+ *
+ * * `Button` Object
+ * * `icon` NativeImage - The icon showing in thumbnail toolbar.
+ * * `click` Function
+ * * `tooltip` String (optional) - The text of the button's tooltip.
+ * * `flags` String[] (optional) - Control specific states and behaviors of the
+ * button. By default, it is `['enabled']`.
+ *
+ * The `flags` is an array that can include following `String`s:
+ *
+ * * `enabled` - The button is active and available to the user.
+ * * `disabled` - The button is disabled. It is present, but has a visual state
+ * indicating it will not respond to user action.
+ * * `dismissonclick` - When the button is clicked, the thumbnail window closes
+ * immediately.
+ * * `nobackground` - Do not draw a button border, use only the image.
+ * * `hidden` - The button is not shown to the user.
+ * * `noninteractive` - The button is enabled but not interactive; no pressed
+ * button state is drawn. This value is intended for instances where the button is
+ * used in a notification.
*/
setThumbarButtons(buttons: ThumbarButton[]): boolean;
/**
* Sets the region of the window to show as the thumbnail image displayed when
* hovering over the window in the taskbar. You can reset the thumbnail to be the
- * entire window by specifying an empty region: { x: 0, y: 0, width: 0, height: 0
- * }.
+ * entire window by specifying an empty region: `{ x: 0, y: 0, width: 0, height: 0
+ * }`.
*/
setThumbnailClip(region: Rectangle): void;
/**
@@ -2029,29 +2501,33 @@ declare namespace Electron {
*/
setThumbnailToolTip(toolTip: string): void;
/**
- * Changes the title of native window to title.
+ * Changes the title of native window to `title`.
*/
setTitle(title: string): void;
/**
- * Sets the touchBar layout for the current window. Specifying null or undefined
- * clears the touch bar. This method only has an effect if the machine has a touch
- * bar and is running on macOS 10.12.1+. Note: The TouchBar API is currently
- * experimental and may change or be removed in future Electron releases.
+ * Sets the touchBar layout for the current window. Specifying `null` or
+ * `undefined` clears the touch bar. This method only has an effect if the machine
+ * has a touch bar and is running on macOS 10.12.1+.
+ *
+ * **Note:** The TouchBar API is currently experimental and may change or be
+ * removed in future Electron releases.
*/
setTouchBar(touchBar: TouchBar): void;
/**
- * Adds a vibrancy effect to the browser window. Passing null or an empty string
+ * Adds a vibrancy effect to the browser window. Passing `null` or an empty string
* will remove the vibrancy effect on the window.
*/
setVibrancy(type: 'appearance-based' | 'light' | 'dark' | 'titlebar' | 'selection' | 'menu' | 'popover' | 'sidebar' | 'medium-light' | 'ultra-dark'): void;
/**
- * Sets whether the window should be visible on all workspaces. Note: This API does
- * nothing on Windows.
+ * Sets whether the window should be visible on all workspaces.
+ *
+**Note:** This API does nothing on Windows.
*/
setVisibleOnAllWorkspaces(visible: boolean, options?: VisibleOnAllWorkspacesOptions): void;
/**
- * Sets whether the window traffic light buttons should be visible. This cannot be
- * called when titleBarStyle is set to customButtonsOnHover.
+ * Sets whether the window traffic light buttons should be visible.
+ *
+This cannot be called when `titleBarStyle` is set to `customButtonsOnHover`.
*/
setWindowButtonVisibility(visible: boolean): void;
/**
@@ -2059,7 +2535,7 @@ declare namespace Electron {
*/
show(): void;
/**
- * Same as webContents.showDefinitionForSelection().
+ * Same as `webContents.showDefinitionForSelection()`.
*/
showDefinitionForSelection(): void;
/**
@@ -2087,7 +2563,7 @@ declare namespace Electron {
webContents: WebContents;
}
- class BrowserWindowProxy extends EventEmitter {
+ class BrowserWindowProxy extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/browser-window-proxy
@@ -2108,9 +2584,11 @@ declare namespace Electron {
*/
focus(): void;
/**
- * Sends a message to the child window with the specified origin or * for no origin
- * preference. In addition to these methods, the child window implements
- * window.opener object with no properties and a single method.
+ * Sends a message to the child window with the specified origin or `*` for no
+ * origin preference.
+ *
+ * In addition to these methods, the child window implements `window.opener` object
+ * with no properties and a single method.
*/
postMessage(message: string, targetOrigin: string): void;
/**
@@ -2196,31 +2674,31 @@ declare namespace Electron {
state: string;
}
- class ClientRequest extends EventEmitter {
+ class ClientRequest extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/client-request
/**
- * Emitted when the request is aborted. The abort event will not be fired if the
- * request is already closed.
+ * Emitted when the `request` is aborted. The `abort` event will not be fired if
+ * the `request` is already closed.
*/
on(event: 'abort', listener: Function): this;
once(event: 'abort', listener: Function): this;
addListener(event: 'abort', listener: Function): this;
removeListener(event: 'abort', listener: Function): this;
/**
- * Emitted as the last event in the HTTP request-response transaction. The close
- * event indicates that no more events will be emitted on either the request or
- * response objects.
+ * Emitted as the last event in the HTTP request-response transaction. The `close`
+ * event indicates that no more events will be emitted on either the `request` or
+ * `response` objects.
*/
on(event: 'close', listener: Function): this;
once(event: 'close', listener: Function): this;
addListener(event: 'close', listener: Function): this;
removeListener(event: 'close', listener: Function): this;
/**
- * Emitted when the net module fails to issue a network request. Typically when the
- * request object emits an error event, a close event will subsequently follow and
- * no response object will be provided.
+ * Emitted when the `net` module fails to issue a network request. Typically when
+ * the `request` object emits an `error` event, a `close` event will subsequently
+ * follow and no response object will be provided.
*/
on(event: 'error', listener: (
/**
@@ -2243,18 +2721,23 @@ declare namespace Electron {
*/
error: Error) => void): this;
/**
- * Emitted just after the last chunk of the request's data has been written into
- * the request object.
+ * Emitted just after the last chunk of the `request`'s data has been written into
+ * the `request` object.
*/
on(event: 'finish', listener: Function): this;
once(event: 'finish', listener: Function): this;
addListener(event: 'finish', listener: Function): this;
removeListener(event: 'finish', listener: Function): this;
/**
- * Emitted when an authenticating proxy is asking for user credentials. The
- * callback function is expected to be called back with user credentials: Providing
- * empty credentials will cancel the request and report an authentication error on
- * the response object:
+ * Emitted when an authenticating proxy is asking for user credentials.
+ *
+ * The `callback` function is expected to be called back with user credentials:
+ *
+ * * `username` String
+ * * `password` String
+ *
+ * Providing empty credentials will cancel the request and report an authentication
+ * error on the response object:
*/
on(event: 'login', listener: (authInfo: AuthInfo,
callback: (username: string, password: string) => void) => void): this;
@@ -2265,8 +2748,8 @@ declare namespace Electron {
removeListener(event: 'login', listener: (authInfo: AuthInfo,
callback: (username: string, password: string) => void) => void): this;
/**
- * Emitted when there is redirection and the mode is manual. Calling
- * request.followRedirect will continue with the redirection.
+ * Emitted when there is redirection and the mode is `manual`. Calling
+ * `request.followRedirect` will continue with the redirection.
*/
on(event: 'redirect', listener: (statusCode: number,
method: string,
@@ -2304,27 +2787,41 @@ declare namespace Electron {
* An object representing the HTTP response message.
*/
response: IncomingMessage) => void): this;
- constructor(options: 'method' | 'url' | 'session' | 'partition' | 'protocol' | 'host' | 'hostname' | 'port' | 'path' | 'redirect');
+ /**
+ * ClientRequest
+ */
+ constructor(options: (any) | (('method' | 'url' | 'session' | 'partition' | 'protocol' | 'host' | 'hostname' | 'port' | 'path' | 'redirect')));
/**
* Cancels an ongoing HTTP transaction. If the request has already emitted the
- * close event, the abort operation will have no effect. Otherwise an ongoing event
- * will emit abort and close events. Additionally, if there is an ongoing response
- * object,it will emit the aborted event.
+ * `close` event, the abort operation will have no effect. Otherwise an ongoing
+ * event will emit `abort` and `close` events. Additionally, if there is an ongoing
+ * response object,it will emit the `aborted` event.
*/
abort(): void;
/**
* Sends the last chunk of the request data. Subsequent write or end operations
- * will not be allowed. The finish event is emitted just after the end operation.
+ * will not be allowed. The `finish` event is emitted just after the end operation.
*/
- end(chunk?: (string) | (Buffer), encoding?: string, callback?: Function): void;
+ end(chunk?: (string) | (Buffer), encoding?: string, callback?: () => void): void;
/**
- * Continues any deferred redirection request when the redirection mode is manual.
+ * Continues any deferred redirection request when the redirection mode is
+ * `manual`.
*/
followRedirect(): void;
+ /**
+ * The value of a previously set extra header name.
+ */
getHeader(name: string): Header;
/**
- * You can use this method in conjunction with POST requests to get the progress of
- * a file upload or other data transfer.
+ * * `active` Boolean - Whether the request is currently active. If this is false
+ * no other properties will be set
+ * * `started` Boolean - Whether the upload has started. If this is false both
+ * `current` and `total` will be set to 0.
+ * * `current` Integer - The number of bytes that have been uploaded so far
+ * * `total` Integer - The number of bytes that will be uploaded this request
+ *
+ * You can use this method in conjunction with `POST` requests to get the progress
+ * of a file upload or other data transfer.
*/
getUploadProgress(): UploadProgress;
/**
@@ -2335,111 +2832,198 @@ declare namespace Electron {
/**
* Adds an extra HTTP header. The header name will issued as it is without
* lowercasing. It can be called only before first write. Calling this method after
- * the first write will throw an error. If the passed value is not a String, its
- * toString() method will be called to obtain the final value.
+ * the first write will throw an error. If the passed value is not a `String`, its
+ * `toString()` method will be called to obtain the final value.
*/
setHeader(name: string, value: any): void;
/**
- * callback is essentially a dummy function introduced in the purpose of keeping
+ * `callback` is essentially a dummy function introduced in the purpose of keeping
* similarity with the Node.js API. It is called asynchronously in the next tick
- * after chunk content have been delivered to the Chromium networking layer.
- * Contrary to the Node.js implementation, it is not guaranteed that chunk content
- * have been flushed on the wire before callback is called. Adds a chunk of data to
- * the request body. The first write operation may cause the request headers to be
- * issued on the wire. After the first write operation, it is not allowed to add or
- * remove a custom header.
- */
- write(chunk: (string) | (Buffer), encoding?: string, callback?: Function): void;
+ * after `chunk` content have been delivered to the Chromium networking layer.
+ * Contrary to the Node.js implementation, it is not guaranteed that `chunk`
+ * content have been flushed on the wire before `callback` is called.
+ *
+ * Adds a chunk of data to the request body. The first write operation may cause
+ * the request headers to be issued on the wire. After the first write operation,
+ * it is not allowed to add or remove a custom header.
+ */
+ write(chunk: (string) | (Buffer), encoding?: string, callback?: () => void): void;
chunkedEncoding: boolean;
}
- interface Clipboard extends EventEmitter {
+ interface Clipboard extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/clipboard
+ /**
+ * An array of supported formats for the clipboard `type`.
+ */
availableFormats(type?: string): string[];
/**
* Clears the clipboard content.
*/
clear(type?: string): void;
+ /**
+ * Whether the clipboard supports the specified `format`.
+ */
has(format: string, type?: string): boolean;
+ /**
+ * Reads `format` type from the clipboard.
+ */
read(format: string): string;
/**
- * Returns an Object containing title and url keys representing the bookmark in the
- * clipboard. The title and url values will be empty strings when the bookmark is
- * unavailable.
+ * * `title` String
+ * * `url` String
+ *
+ * Returns an Object containing `title` and `url` keys representing the bookmark in
+ * the clipboard. The `title` and `url` values will be empty strings when the
+ * bookmark is unavailable.
*/
readBookmark(): ReadBookmark;
+ /**
+ * Reads `format` type from the clipboard.
+ */
readBuffer(format: string): Buffer;
+ /**
+ * The text on the find pasteboard. This method uses synchronous IPC when called
+ * from the renderer process. The cached value is reread from the find pasteboard
+ * whenever the application is activated.
+ */
readFindText(): string;
+ /**
+ * The content in the clipboard as markup.
+ */
readHTML(type?: string): string;
+ /**
+ * The image content in the clipboard.
+ */
readImage(type?: string): NativeImage;
+ /**
+ * The content in the clipboard as RTF.
+ */
readRTF(type?: string): string;
+ /**
+ * The content in the clipboard as plain text.
+ */
readText(type?: string): string;
/**
- * Writes data to the clipboard.
+ * Writes `data` to the clipboard.
*/
write(data: Data, type?: string): void;
/**
- * Writes the title and url into the clipboard as a bookmark. Note: Most apps on
- * Windows don't support pasting bookmarks into them so you can use clipboard.write
- * to write both a bookmark and fallback text to the clipboard.
+ * Writes the `title` and `url` into the clipboard as a bookmark.
+ *
+ * **Note:** Most apps on Windows don't support pasting bookmarks into them so you
+ * can use `clipboard.write` to write both a bookmark and fallback text to the
+ * clipboard.
*/
writeBookmark(title: string, url: string, type?: string): void;
/**
- * Writes the buffer into the clipboard as format.
+ * Writes the `buffer` into the clipboard as `format`.
*/
writeBuffer(format: string, buffer: Buffer, type?: string): void;
/**
- * Writes the text into the find pasteboard as plain text. This method uses
+ * Writes the `text` into the find pasteboard as plain text. This method uses
* synchronous IPC when called from the renderer process.
*/
writeFindText(text: string): void;
/**
- * Writes markup to the clipboard.
+ * Writes `markup` to the clipboard.
*/
writeHTML(markup: string, type?: string): void;
/**
- * Writes image to the clipboard.
+ * Writes `image` to the clipboard.
*/
writeImage(image: NativeImage, type?: string): void;
/**
- * Writes the text into the clipboard in RTF.
+ * Writes the `text` into the clipboard in RTF.
*/
writeRTF(text: string, type?: string): void;
/**
- * Writes the text into the clipboard as plain text.
+ * Writes the `text` into the clipboard as plain text.
*/
writeText(text: string, type?: string): void;
}
- interface ContentTracing extends EventEmitter {
+ class CommandLine {
+
+ // Docs: http://electronjs.org/docs/api/command-line
+
+ /**
+ * Append an argument to Chromium's command line. The argument will be quoted
+ * correctly. Switches will precede arguments regardless of appending order.
+ *
+ * If you're appending an argument like `--switch=value`, consider using
+ * `appendSwitch('switch', 'value')` instead.
+ *
+ * **Note:** This will not affect `process.argv`. The intended usage of this
+ * function is to control Chromium's behavior.
+ */
+ appendArgument(value: string): void;
+ /**
+ * Append a switch (with optional `value`) to Chromium's command line.
+ *
+ * **Note:** This will not affect `process.argv`. The intended usage of this
+ * function is to control Chromium's behavior.
+ */
+ appendSwitch(the_switch: string, value?: string): void;
+ /**
+ * The command-line switch value.
+ *
+ * **Note:** When the switch is not present or has no value, it returns empty
+ * string.
+ */
+ getSwitchValue(the_switch: string): string;
+ /**
+ * Whether the command-line switch is present.
+ */
+ hasSwitch(the_switch: string): boolean;
+ }
+
+ interface ContentTracing extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/content-tracing
/**
+ * resolves with an array of category groups once all child processes have
+ * acknowledged the `getCategories` request
+ *
* Get a set of category groups. The category groups can change as new code paths
* are reached.
*/
getCategories(): Promise<string[]>;
/**
+ * Resolves with an object containing the `value` and `percentage` of trace buffer
+ * maximum usage
+ *
* Get the maximum usage across processes of trace buffer as a percentage of the
* full state.
*/
- getTraceBufferUsage(): Promise<any>;
+ getTraceBufferUsage(): Promise<Electron.TraceBufferUsageReturnValue>;
/**
- * Start recording on all processes. Recording begins immediately locally and
- * asynchronously on child processes as soon as they receive the EnableRecording
+ * resolved once all child processes have acknowledged the `startRecording`
* request.
+ *
+ * Start recording on all processes.
+ *
+ * Recording begins immediately locally and asynchronously on child processes as
+ * soon as they receive the EnableRecording request.
*/
startRecording(options: (TraceCategoriesAndOptions) | (TraceConfig)): Promise<void>;
/**
- * Stop recording on all processes. Child processes typically cache trace data and
- * only rarely flush and send trace data back to the main process. This helps to
- * minimize the runtime overhead of tracing since sending trace data over IPC can
- * be an expensive operation. So, to end tracing, we must asynchronously ask all
- * child processes to flush any pending trace data. Trace data will be written into
- * resultFilePath if it is not empty or into a temporary file.
+ * resolves with a file that contains the traced data once all child processes have
+ * acknowledged the `stopRecording` request
+ *
+ * Stop recording on all processes.
+ *
+ * Child processes typically cache trace data and only rarely flush and send trace
+ * data back to the main process. This helps to minimize the runtime overhead of
+ * tracing since sending trace data over IPC can be an expensive operation. So, to
+ * end tracing, we must asynchronously ask all child processes to flush any pending
+ * trace data.
+ *
+ * Trace data will be written into `resultFilePath` if it is not empty or into a
+ * temporary file.
*/
stopRecording(resultFilePath: string): Promise<string>;
}
@@ -2459,7 +3043,7 @@ declare namespace Electron {
*/
expirationDate?: number;
/**
- * Whether the cookie is a host-only cookie; this will only be true if no domain
+ * Whether the cookie is a host-only cookie; this will only be `true` if no domain
* was passed.
*/
hostOnly?: boolean;
@@ -2490,7 +3074,7 @@ declare namespace Electron {
value: string;
}
- class Cookies extends EventEmitter {
+ class Cookies extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/cookies
@@ -2498,73 +3082,33 @@ declare namespace Electron {
* Emitted when a cookie is changed because it was added, edited, removed, or
* expired.
*/
- on(event: 'changed', listener: (event: Event,
- /**
- * The cookie that was changed.
- */
- cookie: Cookie,
- /**
- * The cause of the change with one of the following values:
- */
- cause: ('explicit' | 'overwrite' | 'expired' | 'evicted' | 'expired-overwrite'),
- /**
- * `true` if the cookie was removed, `false` otherwise.
- */
- removed: boolean) => void): this;
- once(event: 'changed', listener: (event: Event,
- /**
- * The cookie that was changed.
- */
- cookie: Cookie,
- /**
- * The cause of the change with one of the following values:
- */
- cause: ('explicit' | 'overwrite' | 'expired' | 'evicted' | 'expired-overwrite'),
- /**
- * `true` if the cookie was removed, `false` otherwise.
- */
- removed: boolean) => void): this;
- addListener(event: 'changed', listener: (event: Event,
- /**
- * The cookie that was changed.
- */
- cookie: Cookie,
- /**
- * The cause of the change with one of the following values:
- */
- cause: ('explicit' | 'overwrite' | 'expired' | 'evicted' | 'expired-overwrite'),
- /**
- * `true` if the cookie was removed, `false` otherwise.
- */
- removed: boolean) => void): this;
- removeListener(event: 'changed', listener: (event: Event,
- /**
- * The cookie that was changed.
- */
- cookie: Cookie,
- /**
- * The cause of the change with one of the following values:
- */
- cause: ('explicit' | 'overwrite' | 'expired' | 'evicted' | 'expired-overwrite'),
- /**
- * `true` if the cookie was removed, `false` otherwise.
- */
- removed: boolean) => void): this;
+ on(event: 'changed', listener: Function): this;
+ once(event: 'changed', listener: Function): this;
+ addListener(event: 'changed', listener: Function): this;
+ removeListener(event: 'changed', listener: Function): this;
/**
- * Writes any unwritten cookies data to disk.
+ * A promise which resolves when the cookie store has been flushed
+ *
+Writes any unwritten cookies data to disk.
*/
flushStore(): Promise<void>;
/**
- * Sends a request to get all cookies matching filter, and resolves a promise with
- * the response.
+ * A promise which resolves an array of cookie objects.
+ *
+ * Sends a request to get all cookies matching `filter`, and resolves a promise
+ * with the response.
*/
get(filter: Filter): Promise<Electron.Cookie[]>;
/**
- * Removes the cookies matching url and name
+ * A promise which resolves when the cookie has been removed
+ *
+Removes the cookies matching `url` and `name`
*/
remove(url: string, name: string): Promise<void>;
/**
- * Sets a cookie with details.
+ * A promise which resolves when the cookie has been set
+ *
+Sets a cookie with `details`.
*/
set(details: Details): Promise<void>;
}
@@ -2598,17 +3142,17 @@ declare namespace Electron {
/**
* Set an extra parameter to be sent with the crash report. The values specified
- * here will be sent in addition to any values set via the extra option when start
- * was called. This API is only available on macOS, if you need to add/update extra
- * parameters on Linux and Windows after your first call to start you can call
- * start again with the updated extra options.
+ * here will be sent in addition to any values set via the `extra` option when
+ * `start` was called. This API is only available on macOS, if you need to
+ * add/update extra parameters on Linux and Windows after your first call to
+ * `start` you can call `start` again with the updated `extra` options.
*/
addExtraParameter(key: string, value: string): void;
/**
* Returns the date and ID of the last crash report. Only crash reports that have
* been uploaded will be returned; even if a crash report is present on disk it
* will not be returned until it is uploaded. In the case that there are no
- * uploaded reports, null is returned.
+ * uploaded reports, `null` is returned.
*/
getLastCrashReport(): CrashReport;
/**
@@ -2621,7 +3165,10 @@ declare namespace Electron {
*/
getUploadedReports(): CrashReport[];
/**
- * Note: This API can only be called from the main process.
+ * Whether reports should be submitted to the server. Set through the `start`
+ * method or `setUploadToServer`.
+ *
+**Note:** This API can only be called from the main process.
*/
getUploadToServer(): boolean;
/**
@@ -2631,33 +3178,41 @@ declare namespace Electron {
removeExtraParameter(key: string): void;
/**
* This would normally be controlled by user preferences. This has no effect if
- * called before start is called. Note: This API can only be called from the main
- * process.
+ * called before `start` is called.
+ *
+**Note:** This API can only be called from the main process.
*/
setUploadToServer(uploadToServer: boolean): void;
/**
- * You are required to call this method before using any other crashReporter APIs
+ * You are required to call this method before using any other `crashReporter` APIs
* and in each process (main/renderer) from which you want to collect crash
- * reports. You can pass different options to crashReporter.start when calling from
- * different processes. Note Child processes created via the child_process module
- * will not have access to the Electron modules. Therefore, to collect crash
- * reports from them, use process.crashReporter.start instead. Pass the same
- * options as above along with an additional one called crashesDirectory that
- * should point to a directory to store the crash reports temporarily. You can test
- * this out by calling process.crash() to crash the child process. Note: If you
- * need send additional/updated extra parameters after your first call start you
- * can call addExtraParameter on macOS or call start again with the new/updated
- * extra parameters on Linux and Windows. Note: To collect crash reports from child
- * process in Windows, you need to add this extra code as well. This will start the
- * process that will monitor and send the crash reports. Replace submitURL,
- * productName and crashesDirectory with appropriate values. Note: On macOS,
- * Electron uses a new crashpad client for crash collection and reporting. If you
- * want to enable crash reporting, initializing crashpad from the main process
- * using crashReporter.start is required regardless of which process you want to
- * collect crashes from. Once initialized this way, the crashpad handler collects
- * crashes from all processes. You still have to call crashReporter.start from the
- * renderer or child process, otherwise crashes from them will get reported without
- * companyName, productName or any of the extra information.
+ * reports. You can pass different options to `crashReporter.start` when calling
+ * from different processes.
+ *
+ * **Note** Child processes created via the `child_process` module will not have
+ * access to the Electron modules. Therefore, to collect crash reports from them,
+ * use `process.crashReporter.start` instead. Pass the same options as above along
+ * with an additional one called `crashesDirectory` that should point to a
+ * directory to store the crash reports temporarily. You can test this out by
+ * calling `process.crash()` to crash the child process.
+ *
+ * **Note:** If you need send additional/updated `extra` parameters after your
+ * first call `start` you can call `addExtraParameter` on macOS or call `start`
+ * again with the new/updated `extra` parameters on Linux and Windows.
+ *
+ * **Note:** To collect crash reports from child process in Windows, you need to
+ * add this extra code as well. This will start the process that will monitor and
+ * send the crash reports. Replace `submitURL`, `productName` and
+ * `crashesDirectory` with appropriate values.
+ *
+ * **Note:** On macOS, Electron uses a new `crashpad` client for crash collection
+ * and reporting. If you want to enable crash reporting, initializing `crashpad`
+ * from the main process using `crashReporter.start` is required regardless of
+ * which process you want to collect crashes from. Once initialized this way, the
+ * crashpad handler collects crashes from all processes. You still have to call
+ * `crashReporter.start` from the renderer or child process, otherwise crashes from
+ * them will get reported without `companyName`, `productName` or any of the
+ * `extra` information.
*/
start(options: CrashReporterStartOptions): void;
}
@@ -2673,13 +3228,13 @@ declare namespace Electron {
scheme: string;
}
- class Debugger extends EventEmitter {
+ class Debugger extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/debugger
/**
* Emitted when debugging session is terminated. This happens either when
- * webContents is closed or devtools is invoked for the attached webContents.
+ * `webContents` is closed or devtools is invoked for the attached `webContents`.
*/
on(event: 'detach', listener: (event: Event,
/**
@@ -2745,24 +3300,36 @@ declare namespace Electron {
*/
params: any) => void): this;
/**
- * Attaches the debugger to the webContents.
+ * Attaches the debugger to the `webContents`.
*/
attach(protocolVersion?: string): void;
/**
- * Detaches the debugger from the webContents.
+ * Detaches the debugger from the `webContents`.
*/
detach(): void;
+ /**
+ * Whether a debugger is attached to the `webContents`.
+ */
isAttached(): boolean;
/**
- * Send given command to the debugging target.
+ * A promise that resolves with the response defined by the 'returns' attribute of
+ * the command description in the remote debugging protocol or is rejected
+ * indicating the failure of the command.
+ *
+Send given command to the debugging target.
*/
sendCommand(method: string, commandParams?: any): Promise<any>;
}
- interface DesktopCapturer extends EventEmitter {
+ interface DesktopCapturer extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/desktop-capturer
+ /**
+ * Resolves with an array of `DesktopCapturerSource` objects, each
+ * `DesktopCapturerSource` represents a screen or an individual window that can be
+ * captured.
+ */
getSources(options: SourcesOptions): Promise<Electron.DesktopCapturerSource[]>;
}
@@ -2777,157 +3344,268 @@ declare namespace Electron {
*/
appIcon: NativeImage;
/**
- * A unique identifier that will correspond to the id of the matching returned by
- * the . On some platforms, this is equivalent to the XX portion of the id field
- * above and on others it will differ. It will be an empty string if not available.
+ * A unique identifier that will correspond to the `id` of the matching Display
+ * returned by the Screen API. On some platforms, this is equivalent to the `XX`
+ * portion of the `id` field above and on others it will differ. It will be an
+ * empty string if not available.
*/
display_id: string;
/**
- * The identifier of a window or screen that can be used as a chromeMediaSourceId
- * constraint when calling [navigator.webkitGetUserMedia]. The format of the
- * identifier will be window:XX or screen:XX, where XX is a random generated
+ * The identifier of a window or screen that can be used as a `chromeMediaSourceId`
+ * constraint when calling [`navigator.webkitGetUserMedia`]. The format of the
+ * identifier will be `window:XX` or `screen:XX`, where `XX` is a random generated
* number.
*/
id: string;
/**
- * A screen source will be named either Entire Screen or Screen , while the name of
- * a window source will match the window title.
+ * A screen source will be named either `Entire Screen` or `Screen <index>`, while
+ * the name of a window source will match the window title.
*/
name: string;
/**
- * A thumbnail image. There is no guarantee that the size of the thumbnail is the
- * same as the thumbnailSize specified in the options passed to
- * desktopCapturer.getSources. The actual size depends on the scale of the screen
- * or window.
+ * A thumbnail image. **Note:** There is no guarantee that the size of the
+ * thumbnail is the same as the `thumbnailSize` specified in the `options` passed
+ * to `desktopCapturer.getSources`. The actual size depends on the scale of the
+ * screen or window.
*/
thumbnail: NativeImage;
}
- interface Dialog extends EventEmitter {
+ interface Dialog extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/dialog
/**
+ * resolves when the certificate trust dialog is shown.
+ *
* On macOS, this displays a modal dialog that shows a message and certificate
* information, and gives the user the option of trusting/importing the
- * certificate. If you provide a browserWindow argument the dialog will be attached
- * to the parent window, making it modal. On Windows the options are more limited,
- * due to the Win32 APIs used:
+ * certificate. If you provide a `browserWindow` argument the dialog will be
+ * attached to the parent window, making it modal.
+ *
+ * On Windows the options are more limited, due to the Win32 APIs used:
+ *
+ * * The `message` argument is not used, as the OS provides its own confirmation
+ * dialog.
+ * * The `browserWindow` argument is ignored since it is not possible to make this
+ * confirmation dialog modal.
*/
showCertificateTrustDialog(browserWindow: BrowserWindow, options: CertificateTrustDialogOptions): Promise<void>;
/**
+ * resolves when the certificate trust dialog is shown.
+ *
* On macOS, this displays a modal dialog that shows a message and certificate
* information, and gives the user the option of trusting/importing the
- * certificate. If you provide a browserWindow argument the dialog will be attached
- * to the parent window, making it modal. On Windows the options are more limited,
- * due to the Win32 APIs used:
+ * certificate. If you provide a `browserWindow` argument the dialog will be
+ * attached to the parent window, making it modal.
+ *
+ * On Windows the options are more limited, due to the Win32 APIs used:
+ *
+ * * The `message` argument is not used, as the OS provides its own confirmation
+ * dialog.
+ * * The `browserWindow` argument is ignored since it is not possible to make this
+ * confirmation dialog modal.
*/
showCertificateTrustDialog(options: CertificateTrustDialogOptions): Promise<void>;
/**
- * Displays a modal dialog that shows an error message. This API can be called
- * safely before the ready event the app module emits, it is usually used to report
- * errors in early stage of startup. If called before the app readyevent on Linux,
- * the message will be emitted to stderr, and no GUI dialog will appear.
+ * Displays a modal dialog that shows an error message.
+ *
+ * This API can be called safely before the `ready` event the `app` module emits,
+ * it is usually used to report errors in early stage of startup. If called before
+ * the app `ready`event on Linux, the message will be emitted to stderr, and no GUI
+ * dialog will appear.
*/
showErrorBox(title: string, content: string): void;
/**
+ * resolves with a promise containing the following properties:
+ *
+ * * `response` Number - The index of the clicked button.
+ * * `checkboxChecked` Boolean - The checked state of the checkbox if
+ * `checkboxLabel` was set. Otherwise `false`.
+ *
* Shows a message box, it will block the process until the message box is closed.
- * The browserWindow argument allows the dialog to attach itself to a parent
+ *
+ * The `browserWindow` argument allows the dialog to attach itself to a parent
* window, making it modal.
*/
showMessageBox(browserWindow: BrowserWindow, options: MessageBoxOptions): Promise<Electron.MessageBoxReturnValue>;
/**
+ * resolves with a promise containing the following properties:
+ *
+ * * `response` Number - The index of the clicked button.
+ * * `checkboxChecked` Boolean - The checked state of the checkbox if
+ * `checkboxLabel` was set. Otherwise `false`.
+ *
* Shows a message box, it will block the process until the message box is closed.
- * The browserWindow argument allows the dialog to attach itself to a parent
+ *
+ * The `browserWindow` argument allows the dialog to attach itself to a parent
* window, making it modal.
*/
showMessageBox(options: MessageBoxOptions): Promise<Electron.MessageBoxReturnValue>;
/**
+ * the index of the clicked button.
+ *
* Shows a message box, it will block the process until the message box is closed.
- * It returns the index of the clicked button. The browserWindow argument allows
- * the dialog to attach itself to a parent window, making it modal.
+ * It returns the index of the clicked button.
+ *
+ * The `browserWindow` argument allows the dialog to attach itself to a parent
+ * window, making it modal.
*/
showMessageBoxSync(browserWindow: BrowserWindow, options: MessageBoxSyncOptions): number;
/**
+ * the index of the clicked button.
+ *
* Shows a message box, it will block the process until the message box is closed.
- * It returns the index of the clicked button. The browserWindow argument allows
- * the dialog to attach itself to a parent window, making it modal.
+ * It returns the index of the clicked button.
+ *
+ * The `browserWindow` argument allows the dialog to attach itself to a parent
+ * window, making it modal.
*/
showMessageBoxSync(options: MessageBoxSyncOptions): number;
/**
- * The browserWindow argument allows the dialog to attach itself to a parent
- * window, making it modal. The filters specifies an array of file types that can
- * be displayed or selected when you want to limit the user to a specific type. For
- * example: The extensions array should contain extensions without wildcards or
- * dots (e.g. 'png' is good but '.png' and '*.png' are bad). To show all files, use
- * the '*' wildcard (no other wildcard is supported). Note: On Windows and Linux an
- * open dialog can not be both a file selector and a directory selector, so if you
- * set properties to ['openFile', 'openDirectory'] on these platforms, a directory
- * selector will be shown.
- */
- showOpenDialog(browserWindow: BrowserWindow, options: OpenDialogOptions, callback?: Function): Promise<Electron.OpenDialogReturnValue>;
- /**
- * The browserWindow argument allows the dialog to attach itself to a parent
- * window, making it modal. The filters specifies an array of file types that can
- * be displayed or selected when you want to limit the user to a specific type. For
- * example: The extensions array should contain extensions without wildcards or
- * dots (e.g. 'png' is good but '.png' and '*.png' are bad). To show all files, use
- * the '*' wildcard (no other wildcard is supported). Note: On Windows and Linux an
- * open dialog can not be both a file selector and a directory selector, so if you
- * set properties to ['openFile', 'openDirectory'] on these platforms, a directory
- * selector will be shown.
- */
- showOpenDialog(options: OpenDialogOptions, callback?: Function): Promise<Electron.OpenDialogReturnValue>;
- /**
- * The browserWindow argument allows the dialog to attach itself to a parent
- * window, making it modal. The filters specifies an array of file types that can
- * be displayed or selected when you want to limit the user to a specific type. For
- * example: The extensions array should contain extensions without wildcards or
- * dots (e.g. 'png' is good but '.png' and '*.png' are bad). To show all files, use
- * the '*' wildcard (no other wildcard is supported). Note: On Windows and Linux an
- * open dialog can not be both a file selector and a directory selector, so if you
- * set properties to ['openFile', 'openDirectory'] on these platforms, a directory
- * selector will be shown.
+ * Resolve wih an object containing the following:
+ *
+ * * `canceled` Boolean - whether or not the dialog was canceled.
+ * * `filePaths` String[] (optional) - An array of file paths chosen by the user.
+ * If the dialog is cancelled this will be an empty array.
+ * * `bookmarks` String[] (optional) _macOS_ _mas_ - An array matching the
+ * `filePaths` array of base64 encoded strings which contains security scoped
+ * bookmark data. `securityScopedBookmarks` must be enabled for this to be
+ * populated.
+ *
+ * The `browserWindow` argument allows the dialog to attach itself to a parent
+ * window, making it modal.
+ *
+ * The `filters` specifies an array of file types that can be displayed or selected
+ * when you want to limit the user to a specific type. For example:
+ *
+ * The `extensions` array should contain extensions without wildcards or dots (e.g.
+ * `'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the
+ * `'*'` wildcard (no other wildcard is supported).
+ *
+ * **Note:** On Windows and Linux an open dialog can not be both a file selector
+ * and a directory selector, so if you set `properties` to `['openFile',
+ * 'openDirectory']` on these platforms, a directory selector will be shown.
+ */
+ showOpenDialog(browserWindow: BrowserWindow, options: OpenDialogOptions, callback?: () => void): Promise<Electron.OpenDialogReturnValue>;
+ /**
+ * Resolve wih an object containing the following:
+ *
+ * * `canceled` Boolean - whether or not the dialog was canceled.
+ * * `filePaths` String[] (optional) - An array of file paths chosen by the user.
+ * If the dialog is cancelled this will be an empty array.
+ * * `bookmarks` String[] (optional) _macOS_ _mas_ - An array matching the
+ * `filePaths` array of base64 encoded strings which contains security scoped
+ * bookmark data. `securityScopedBookmarks` must be enabled for this to be
+ * populated.
+ *
+ * The `browserWindow` argument allows the dialog to attach itself to a parent
+ * window, making it modal.
+ *
+ * The `filters` specifies an array of file types that can be displayed or selected
+ * when you want to limit the user to a specific type. For example:
+ *
+ * The `extensions` array should contain extensions without wildcards or dots (e.g.
+ * `'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the
+ * `'*'` wildcard (no other wildcard is supported).
+ *
+ * **Note:** On Windows and Linux an open dialog can not be both a file selector
+ * and a directory selector, so if you set `properties` to `['openFile',
+ * 'openDirectory']` on these platforms, a directory selector will be shown.
+ */
+ showOpenDialog(options: OpenDialogOptions, callback?: () => void): Promise<Electron.OpenDialogReturnValue>;
+ /**
+ * The `browserWindow` argument allows the dialog to attach itself to a parent
+ * window, making it modal.
+ *
+ * The `filters` specifies an array of file types that can be displayed or selected
+ * when you want to limit the user to a specific type. For example:
+ *
+ * The `extensions` array should contain extensions without wildcards or dots (e.g.
+ * `'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the
+ * `'*'` wildcard (no other wildcard is supported).
+ *
+ * **Note:** On Windows and Linux an open dialog can not be both a file selector
+ * and a directory selector, so if you set `properties` to `['openFile',
+ * 'openDirectory']` on these platforms, a directory selector will be shown.
*/
showOpenDialogSync(options: OpenDialogSyncOptions): void;
/**
- * The browserWindow argument allows the dialog to attach itself to a parent
- * window, making it modal. The filters specifies an array of file types that can
- * be displayed or selected when you want to limit the user to a specific type. For
- * example: The extensions array should contain extensions without wildcards or
- * dots (e.g. 'png' is good but '.png' and '*.png' are bad). To show all files, use
- * the '*' wildcard (no other wildcard is supported). Note: On Windows and Linux an
- * open dialog can not be both a file selector and a directory selector, so if you
- * set properties to ['openFile', 'openDirectory'] on these platforms, a directory
- * selector will be shown.
+ * The `browserWindow` argument allows the dialog to attach itself to a parent
+ * window, making it modal.
+ *
+ * The `filters` specifies an array of file types that can be displayed or selected
+ * when you want to limit the user to a specific type. For example:
+ *
+ * The `extensions` array should contain extensions without wildcards or dots (e.g.
+ * `'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the
+ * `'*'` wildcard (no other wildcard is supported).
+ *
+ * **Note:** On Windows and Linux an open dialog can not be both a file selector
+ * and a directory selector, so if you set `properties` to `['openFile',
+ * 'openDirectory']` on these platforms, a directory selector will be shown.
*/
showOpenDialogSync(browserWindow: BrowserWindow, options: OpenDialogSyncOptions): void;
/**
- * The browserWindow argument allows the dialog to attach itself to a parent
- * window, making it modal. The filters specifies an array of file types that can
- * be displayed, see dialog.showOpenDialog for an example. Note: On macOS, using
- * the asynchronous version is recommended to avoid issues when expanding and
- * collapsing the dialog.
+ * Resolve with an object containing the following:
+ *
+ * * `canceled` Boolean - whether or not the dialog was canceled.
+ * * `filePath` String (optional) - If the dialog is canceled this will be
+ * `undefined`.
+ * * `bookmark` String (optional) _macOS_ _mas_ - Base64 encoded string which
+ * contains the security scoped bookmark data for the saved file.
+ * `securityScopedBookmarks` must be enabled for this to be present.
+ *
+ * The `browserWindow` argument allows the dialog to attach itself to a parent
+ * window, making it modal.
+ *
+ * The `filters` specifies an array of file types that can be displayed, see
+ * `dialog.showOpenDialog` for an example.
+ *
+ * **Note:** On macOS, using the asynchronous version is recommended to avoid
+ * issues when expanding and collapsing the dialog.
*/
showSaveDialog(options: SaveDialogOptions): Promise<Electron.SaveDialogReturnValue>;
/**
- * The browserWindow argument allows the dialog to attach itself to a parent
- * window, making it modal. The filters specifies an array of file types that can
- * be displayed, see dialog.showOpenDialog for an example.
+ * the path of the file chosen by the user; if the dialog is cancelled it returns
+ * `undefined`.
+ *
+ * The `browserWindow` argument allows the dialog to attach itself to a parent
+ * window, making it modal.
+ *
+ * The `filters` specifies an array of file types that can be displayed, see
+ * `dialog.showOpenDialog` for an example.
*/
showSaveDialog(options: SaveDialogOptions): (string) | (undefined);
/**
- * The browserWindow argument allows the dialog to attach itself to a parent
- * window, making it modal. The filters specifies an array of file types that can
- * be displayed, see dialog.showOpenDialog for an example. Note: On macOS, using
- * the asynchronous version is recommended to avoid issues when expanding and
- * collapsing the dialog.
+ * Resolve with an object containing the following:
+ *
+ * * `canceled` Boolean - whether or not the dialog was canceled.
+ * * `filePath` String (optional) - If the dialog is canceled this will be
+ * `undefined`.
+ * * `bookmark` String (optional) _macOS_ _mas_ - Base64 encoded string which
+ * contains the security scoped bookmark data for the saved file.
+ * `securityScopedBookmarks` must be enabled for this to be present.
+ *
+ * The `browserWindow` argument allows the dialog to attach itself to a parent
+ * window, making it modal.
+ *
+ * The `filters` specifies an array of file types that can be displayed, see
+ * `dialog.showOpenDialog` for an example.
+ *
+ * **Note:** On macOS, using the asynchronous version is recommended to avoid
+ * issues when expanding and collapsing the dialog.
*/
showSaveDialog(browserWindow: BrowserWindow, options: SaveDialogOptions): Promise<Electron.SaveDialogReturnValue>;
/**
- * The browserWindow argument allows the dialog to attach itself to a parent
- * window, making it modal. The filters specifies an array of file types that can
- * be displayed, see dialog.showOpenDialog for an example.
+ * the path of the file chosen by the user; if the dialog is cancelled it returns
+ * `undefined`.
+ *
+ * The `browserWindow` argument allows the dialog to attach itself to a parent
+ * window, making it modal.
+ *
+ * The `filters` specifies an array of file types that can be displayed, see
+ * `dialog.showOpenDialog` for an example.
*/
showSaveDialog(browserWindow: BrowserWindow, options: SaveDialogOptions): (string) | (undefined);
}
@@ -2937,7 +3615,7 @@ declare namespace Electron {
// Docs: http://electronjs.org/docs/api/structures/display
/**
- * Can be available, unavailable, unknown.
+ * Can be `available`, `unavailable`, `unknown`.
*/
accelerometerSupport: ('available' | 'unavailable' | 'unknown');
bounds: Rectangle;
@@ -2959,7 +3637,7 @@ declare namespace Electron {
*/
id: number;
/**
- * true for an internal display and false for an external display
+ * `true` for an internal display and `false` for an external display
*/
internal: boolean;
/**
@@ -2976,21 +3654,84 @@ declare namespace Electron {
scaleFactor: number;
size: Size;
/**
- * Can be available, unavailable, unknown.
+ * Can be `available`, `unavailable`, `unknown`.
*/
touchSupport: ('available' | 'unavailable' | 'unknown');
workArea: Rectangle;
workAreaSize: Size;
}
- class DownloadItem extends EventEmitter {
+ class Dock {
+
+ // Docs: http://electronjs.org/docs/api/dock
+
+ /**
+ * When `critical` is passed, the dock icon will bounce until either the
+ * application becomes active or the request is canceled.
+ *
+ * When `informational` is passed, the dock icon will bounce for one second.
+ * However, the request remains active until either the application becomes active
+ * or the request is canceled.
+
+an ID representing the request.
+ */
+ bounce(type?: 'critical' | 'informational'): number;
+ /**
+ * Cancel the bounce of `id`.
+ */
+ cancelBounce(id: number): void;
+ /**
+ * Bounces the Downloads stack if the filePath is inside the Downloads folder.
+ */
+ downloadFinished(filePath: string): void;
+ /**
+ * The badge string of the dock.
+ */
+ getBadge(): string;
+ /**
+ * The application's [dock menu][dock-menu].
+ */
+ getMenu(): (Menu) | (null);
+ /**
+ * Hides the dock icon.
+ */
+ hide(): void;
+ /**
+ * Whether the dock icon is visible.
+ */
+ isVisible(): boolean;
+ /**
+ * Sets the string to be displayed in the dock’s badging area.
+ */
+ setBadge(text: string): void;
+ /**
+ * Sets the `image` associated with this dock icon.
+ */
+ setIcon(image: (NativeImage) | (string)): void;
+ /**
+ * Sets the application's [dock menu][dock-menu].
+ */
+ setMenu(menu: Menu): void;
+ /**
+ * Resolves when the dock icon is shown.
+ */
+ show(): Promise<void>;
+ }
+
+ class DownloadItem extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/download-item
/**
* Emitted when the download is in a terminal state. This includes a completed
- * download, a cancelled download (via downloadItem.cancel()), and interrupted
- * download that can't be resumed. The state can be one of following:
+ * download, a cancelled download (via `downloadItem.cancel()`), and interrupted
+ * download that can't be resumed.
+ *
+ * The `state` can be one of following:
+ *
+ * * `completed` - The download completed successfully.
+ * * `cancelled` - The download has been cancelled.
+ * * `interrupted` - The download has interrupted and can not resume.
*/
on(event: 'done', listener: (event: Event,
/**
@@ -3013,8 +3754,12 @@ declare namespace Electron {
*/
state: ('completed' | 'cancelled' | 'interrupted')) => void): this;
/**
- * Emitted when the download has been updated and is not done. The state can be one
- * of following:
+ * Emitted when the download has been updated and is not done.
+ *
+ * The `state` can be one of following:
+ *
+ * * `progressing` - The download is in-progress.
+ * * `interrupted` - The download has interrupted and can be resumed.
*/
on(event: 'updated', listener: (event: Event,
/**
@@ -3040,55 +3785,106 @@ declare namespace Electron {
* Cancels the download operation.
*/
cancel(): void;
+ /**
+ * Whether the download can resume.
+ */
canResume(): boolean;
+ /**
+ * The Content-Disposition field from the response header.
+ */
getContentDisposition(): string;
+ /**
+ * ETag header value.
+ */
getETag(): string;
/**
- * Note: The file name is not always the same as the actual one saved in local
+ * The file name of the download item.
+ *
+ * **Note:** The file name is not always the same as the actual one saved in local
* disk. If user changes the file name in a prompted download saving dialog, the
* actual name of saved file will be different.
*/
getFilename(): string;
+ /**
+ * Last-Modified header value.
+ */
getLastModifiedTime(): string;
+ /**
+ * The files mime type.
+ */
getMimeType(): string;
+ /**
+ * The received bytes of the download item.
+ */
getReceivedBytes(): number;
+ /**
+ * Returns the object previously set by
+ * `downloadItem.setSaveDialogOptions(options)`.
+ */
getSaveDialogOptions(): SaveDialogOptions;
+ /**
+ * The save path of the download item. This will be either the path set via
+ * `downloadItem.setSavePath(path)` or the path selected from the shown save
+ * dialog.
+ */
getSavePath(): string;
+ /**
+ * Number of seconds since the UNIX epoch when the download was started.
+ */
getStartTime(): number;
/**
- * Note: The following methods are useful specifically to resume a cancelled item
- * when session is restarted.
+ * The current state. Can be `progressing`, `completed`, `cancelled` or
+ * `interrupted`.
+ *
+ * **Note:** The following methods are useful specifically to resume a `cancelled`
+ * item when session is restarted.
*/
getState(): ('progressing' | 'completed' | 'cancelled' | 'interrupted');
/**
- * If the size is unknown, it returns 0.
+ * The total size in bytes of the download item.
+ *
+If the size is unknown, it returns 0.
*/
getTotalBytes(): number;
+ /**
+ * The origin url where the item is downloaded from.
+ */
getURL(): string;
+ /**
+ * The complete url chain of the item including any redirects.
+ */
getURLChain(): string[];
+ /**
+ * Whether the download has user gesture.
+ */
hasUserGesture(): boolean;
+ /**
+ * Whether the download is paused.
+ */
isPaused(): boolean;
/**
* Pauses the download.
*/
pause(): void;
/**
- * Resumes the download that has been paused. Note: To enable resumable downloads
- * the server you are downloading from must support range requests and provide both
- * Last-Modified and ETag header values. Otherwise resume() will dismiss previously
- * received bytes and restart the download from the beginning.
+ * Resumes the download that has been paused.
+ *
+ * **Note:** To enable resumable downloads the server you are downloading from must
+ * support range requests and provide both `Last-Modified` and `ETag` header
+ * values. Otherwise `resume()` will dismiss previously received bytes and restart
+ * the download from the beginning.
*/
resume(): void;
/**
* This API allows the user to set custom options for the save dialog that opens
* for the download item by default. The API is only available in session's
- * will-download callback function.
+ * `will-download` callback function.
*/
setSaveDialogOptions(options: SaveDialogOptions): void;
/**
- * The API is only available in session's will-download callback function. If user
- * doesn't set the save path via the API, Electron will use the original routine to
- * determine the save path(Usually prompts a save dialog).
+ * The API is only available in session's `will-download` callback function. If
+ * user doesn't set the save path via the API, Electron will use the original
+ * routine to determine the save path(Usually prompts a save dialog).
*/
setSavePath(path: string): void;
}
@@ -3108,38 +3904,57 @@ declare namespace Electron {
name: string;
}
- interface GlobalShortcut extends EventEmitter {
+ interface GlobalShortcut extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/global-shortcut
/**
+ * Whether this application has registered `accelerator`.
+ *
* When the accelerator is already taken by other applications, this call will
- * still return false. This behavior is intended by operating systems, since they
+ * still return `false`. This behavior is intended by operating systems, since they
* don't want applications to fight for global shortcuts.
*/
isRegistered(accelerator: Accelerator): boolean;
/**
- * Registers a global shortcut of accelerator. The callback is called when the
- * registered shortcut is pressed by the user. When the accelerator is already
- * taken by other applications, this call will silently fail. This behavior is
- * intended by operating systems, since they don't want applications to fight for
- * global shortcuts. The following accelerators will not be registered successfully
- * on macOS 10.14 Mojave unless the app has been authorized as a trusted
- * accessibility client:
- */
- register(accelerator: Accelerator, callback: Function): boolean;
- /**
- * Registers a global shortcut of all accelerator items in accelerators. The
- * callback is called when any of the registered shortcuts are pressed by the user.
+ * Whether or not the shortcut was registered successfully.
+ *
+ * Registers a global shortcut of `accelerator`. The `callback` is called when the
+ * registered shortcut is pressed by the user.
+ *
+ * When the accelerator is already taken by other applications, this call will
+ * silently fail. This behavior is intended by operating systems, since they don't
+ * want applications to fight for global shortcuts.
+ *
+ * The following accelerators will not be registered successfully on macOS 10.14
+ * Mojave unless the app has been authorized as a trusted accessibility client:
+ *
+ * * "Media Play/Pause"
+ * * "Media Next Track"
+* "Media Previous Track"
+* "Media Stop"
+ */
+ register(accelerator: Accelerator, callback: () => void): boolean;
+ /**
+ * Registers a global shortcut of all `accelerator` items in `accelerators`. The
+ * `callback` is called when any of the registered shortcuts are pressed by the
+ * user.
+ *
* When a given accelerator is already taken by other applications, this call will
* silently fail. This behavior is intended by operating systems, since they don't
- * want applications to fight for global shortcuts. The following accelerators will
- * not be registered successfully on macOS 10.14 Mojave unless the app has been
- * authorized as a trusted accessibility client:
+ * want applications to fight for global shortcuts.
+ *
+ * The following accelerators will not be registered successfully on macOS 10.14
+ * Mojave unless the app has been authorized as a trusted accessibility client:
+ *
+ * * "Media Play/Pause"
+ * * "Media Next Track"
+* "Media Previous Track"
+* "Media Stop"
*/
- registerAll(accelerators: string[], callback: Function): void;
+ registerAll(accelerators: string[], callback: () => void): void;
/**
- * Unregisters the global shortcut of accelerator.
+ * Unregisters the global shortcut of `accelerator`.
*/
unregister(accelerator: Accelerator): void;
/**
@@ -3206,33 +4021,17 @@ declare namespace Electron {
webgl2: string;
}
- interface InAppPurchase extends EventEmitter {
+ interface InAppPurchase extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/in-app-purchase
+ on(event: 'transactions-updated', listener: Function): this;
+ once(event: 'transactions-updated', listener: Function): this;
+ addListener(event: 'transactions-updated', listener: Function): this;
+ removeListener(event: 'transactions-updated', listener: Function): this;
/**
- * Emitted when one or more transactions have been updated.
+ * whether a user can make a payment.
*/
- on(event: 'transactions-updated', listener: (event: Event,
- /**
- * Array of objects.
- */
- transactions: Transaction[]) => void): this;
- once(event: 'transactions-updated', listener: (event: Event,
- /**
- * Array of objects.
- */
- transactions: Transaction[]) => void): this;
- addListener(event: 'transactions-updated', listener: (event: Event,
- /**
- * Array of objects.
- */
- transactions: Transaction[]) => void): this;
- removeListener(event: 'transactions-updated', listener: (event: Event,
- /**
- * Array of objects.
- */
- transactions: Transaction[]) => void): this;
canMakePayments(): boolean;
/**
* Completes all pending transactions.
@@ -3243,18 +4042,25 @@ declare namespace Electron {
*/
finishTransactionByDate(date: string): void;
/**
- * Retrieves the product descriptions.
+ * Resolves with an array of `Product` objects.
+ *
+Retrieves the product descriptions.
*/
getProducts(productIDs: string[]): Promise<Electron.Product[]>;
+ /**
+ * the path to the receipt.
+ */
getReceiptURL(): string;
/**
- * You should listen for the transactions-updated event as soon as possible and
- * certainly before you call purchaseProduct.
+ * Returns `true` if the product is valid and added to the payment queue.
+ *
+ * You should listen for the `transactions-updated` event as soon as possible and
+ * certainly before you call `purchaseProduct`.
*/
purchaseProduct(productID: string, quantity?: number): Promise<boolean>;
}
- class IncomingMessage extends EventEmitter {
+ class IncomingMessage extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/incoming-message
@@ -3266,7 +4072,7 @@ declare namespace Electron {
addListener(event: 'aborted', listener: Function): this;
removeListener(event: 'aborted', listener: Function): this;
/**
- * The data event is the usual method of transferring response data into
+ * The `data` event is the usual method of transferring response data into
* applicative code.
*/
on(event: 'data', listener: (
@@ -3297,10 +4103,13 @@ declare namespace Electron {
addListener(event: 'end', listener: Function): this;
removeListener(event: 'end', listener: Function): this;
/**
- * error Error - Typically holds an error string identifying failure root cause.
+ * Returns:
+ *
+ * `error` Error - Typically holds an error string identifying failure root cause.
+ *
* Emitted when an error was encountered while streaming response data events. For
* instance, if the server closes the underlying while the response is still
- * streaming, an error event will be emitted on the response object and a close
+ * streaming, an `error` event will be emitted on the response object and a `close`
* event will subsequently follow on the request object.
*/
on(event: 'error', listener: Function): this;
@@ -3345,29 +4154,29 @@ declare namespace Electron {
writeTransferCount: number;
}
- interface IpcMain extends EventEmitter {
+ interface IpcMain extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/ipc-main
/**
- * Listens to channel, when a new message arrives listener would be called with
- * listener(event, args...).
+ * Listens to `channel`, when a new message arrives `listener` would be called with
+ * `listener(event, args...)`.
*/
on(channel: string, listener: (event: IpcMainEvent, ...args: any[]) => void): this;
/**
- * Adds a one time listener function for the event. This listener is invoked only
- * the next time a message is sent to channel, after which it is removed.
+ * Adds a one time `listener` function for the event. This `listener` is invoked
+ * only the next time a message is sent to `channel`, after which it is removed.
*/
once(channel: string, listener: (event: IpcMainEvent, ...args: any[]) => void): this;
/**
- * Removes listeners of the specified channel.
+ * Removes listeners of the specified `channel`.
*/
removeAllListeners(channel: string): this;
/**
- * Removes the specified listener from the listener array for the specified
- * channel.
+ * Removes the specified `listener` from the listener array for the specified
+ * `channel`.
*/
- removeListener(channel: string, listener: Function): this;
+ removeListener(channel: string, listener: () => void): this;
}
interface IpcMainEvent extends Event {
@@ -3380,7 +4189,7 @@ declare namespace Electron {
frameId: number;
/**
* A function that will send an IPC message to the renderer frame that sent the
- * original message that you are currently handling. You should use this method to
+ * original message that you are currently handling. You should use this method to
* "reply" to the sent message in order to guaruntee the reply will go to the
* correct process and frame.
*/
@@ -3390,57 +4199,63 @@ declare namespace Electron {
*/
returnValue: any;
/**
- * Returns the webContents that sent the message
+ * Returns the `webContents` that sent the message
*/
sender: WebContents;
}
- interface IpcRenderer extends EventEmitter {
+ interface IpcRenderer extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/ipc-renderer
/**
- * Listens to channel, when a new message arrives listener would be called with
- * listener(event, args...).
+ * Listens to `channel`, when a new message arrives `listener` would be called with
+ * `listener(event, args...)`.
*/
on(channel: string, listener: (event: IpcRendererEvent, ...args: any[]) => void): this;
/**
- * Adds a one time listener function for the event. This listener is invoked only
- * the next time a message is sent to channel, after which it is removed.
+ * Adds a one time `listener` function for the event. This `listener` is invoked
+ * only the next time a message is sent to `channel`, after which it is removed.
*/
once(channel: string, listener: (event: IpcRendererEvent, ...args: any[]) => void): this;
/**
- * Removes all listeners, or those of the specified channel.
+ * Removes all listeners, or those of the specified `channel`.
*/
removeAllListeners(channel: string): this;
/**
- * Removes the specified listener from the listener array for the specified
- * channel.
+ * Removes the specified `listener` from the listener array for the specified
+ * `channel`.
*/
- removeListener(channel: string, listener: Function): this;
+ removeListener(channel: string, listener: () => void): this;
/**
- * Send a message to the main process asynchronously via channel, you can also send
- * arbitrary arguments. Arguments will be serialized in JSON internally and hence
- * no functions or prototype chain will be included. The main process handles it by
- * listening for channel with ipcMain module.
+ * Send a message to the main process asynchronously via `channel`, you can also
+ * send arbitrary arguments. Arguments will be serialized in JSON internally and
+ * hence no functions or prototype chain will be included.
+ *
+The main process handles it by listening for `channel` with `ipcMain` module.
*/
send(channel: string, ...args: any[]): void;
/**
- * Send a message to the main process synchronously via channel, you can also send
- * arbitrary arguments. Arguments will be serialized in JSON internally and hence
- * no functions or prototype chain will be included. The main process handles it by
- * listening for channel with ipcMain module, and replies by setting
- * event.returnValue. Note: Sending a synchronous message will block the whole
- * renderer process, unless you know what you are doing you should never use it.
+ * The value sent back by the `ipcMain` handler.
+ *
+ * Send a message to the main process synchronously via `channel`, you can also
+ * send arbitrary arguments. Arguments will be serialized in JSON internally and
+ * hence no functions or prototype chain will be included.
+ *
+ * The main process handles it by listening for `channel` with `ipcMain` module,
+ * and replies by setting `event.returnValue`.
+ *
+ * **Note:** Sending a synchronous message will block the whole renderer process,
+ * unless you know what you are doing you should never use it.
*/
sendSync(channel: string, ...args: any[]): any;
/**
- * Sends a message to a window with webContentsId via channel.
+ * Sends a message to a window with `webContentsId` via `channel`.
*/
sendTo(webContentsId: number, channel: string, ...args: any[]): void;
/**
- * Like ipcRenderer.send but the event will be sent to the <webview> element in the
- * host page instead of the main process.
+ * Like `ipcRenderer.send` but the event will be sent to the `<webview>` element in
+ * the host page instead of the main process.
*/
sendToHost(channel: string, ...args: any[]): void;
}
@@ -3450,14 +4265,15 @@ declare namespace Electron {
// Docs: http://electronjs.org/docs/api/structures/ipc-renderer-event
/**
- * The IpcRenderer instance that emitted the event originally
+ * The `IpcRenderer` instance that emitted the event originally
*/
sender: IpcRenderer;
/**
- * The webContents.id that sent the message, you can call
- * event.sender.sendTo(event.senderId, ...) to reply to the message, see for more
- * information. This only applies to messages sent from a different renderer.
- * Messages sent directly from the main process set event.senderId to 0.
+ * The `webContents.id` that sent the message, you can call
+ * `event.sender.sendTo(event.senderId, ...)` to reply to the message, see
+ * ipcRenderer.sendTo for more information. This only applies to messages sent from
+ * a different renderer. Messages sent directly from the main process set
+ * `event.senderId` to `0`.
*/
senderId: number;
}
@@ -3467,11 +4283,12 @@ declare namespace Electron {
// Docs: http://electronjs.org/docs/api/structures/jump-list-category
/**
- * Array of objects if type is tasks or custom, otherwise it should be omitted.
+ * Array of `JumpListItem` objects if `type` is `tasks` or `custom`, otherwise it
+ * should be omitted.
*/
items?: JumpListItem[];
/**
- * Must be set if type is custom, otherwise it should be omitted.
+ * Must be set if `type` is `custom`, otherwise it should be omitted.
*/
name?: string;
/**
@@ -3485,13 +4302,13 @@ declare namespace Electron {
// Docs: http://electronjs.org/docs/api/structures/jump-list-item
/**
- * The command line arguments when program is executed. Should only be set if type
- * is task.
+ * The command line arguments when `program` is executed. Should only be set if
+ * `type` is `task`.
*/
args?: string;
/**
- * Description of the task (displayed in a tooltip). Should only be set if type is
- * task.
+ * Description of the task (displayed in a tooltip). Should only be set if `type`
+ * is `task`.
*/
description?: string;
/**
@@ -3503,22 +4320,22 @@ declare namespace Electron {
iconIndex?: number;
/**
* The absolute path to an icon to be displayed in a Jump List, which can be an
- * arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll). You can
- * usually specify process.execPath to show the program icon.
+ * arbitrary resource file that contains an icon (e.g. `.ico`, `.exe`, `.dll`). You
+ * can usually specify `process.execPath` to show the program icon.
*/
iconPath?: string;
/**
- * Path of the file to open, should only be set if type is file.
+ * Path of the file to open, should only be set if `type` is `file`.
*/
path?: string;
/**
- * Path of the program to execute, usually you should specify process.execPath
- * which opens the current program. Should only be set if type is task.
+ * Path of the program to execute, usually you should specify `process.execPath`
+ * which opens the current program. Should only be set if `type` is `task`.
*/
program?: string;
/**
* The text to be displayed for the item in the Jump List. Should only be set if
- * type is task.
+ * `type` is `task`.
*/
title?: string;
/**
@@ -3597,67 +4414,83 @@ declare namespace Electron {
// Docs: http://electronjs.org/docs/api/menu
/**
- * Emitted when a popup is closed either manually or with menu.closePopup().
+ * Emitted when a popup is closed either manually or with `menu.closePopup()`.
*/
on(event: 'menu-will-close', listener: (event: Event) => void): this;
once(event: 'menu-will-close', listener: (event: Event) => void): this;
addListener(event: 'menu-will-close', listener: (event: Event) => void): this;
removeListener(event: 'menu-will-close', listener: (event: Event) => void): this;
/**
- * Emitted when menu.popup() is called.
+ * Emitted when `menu.popup()` is called.
*/
on(event: 'menu-will-show', listener: (event: Event) => void): this;
once(event: 'menu-will-show', listener: (event: Event) => void): this;
addListener(event: 'menu-will-show', listener: (event: Event) => void): this;
removeListener(event: 'menu-will-show', listener: (event: Event) => void): this;
+ /**
+ * Menu
+ */
constructor();
/**
- * Generally, the template is an array of options for constructing a MenuItem. The
- * usage can be referenced above. You can also attach other fields to the element
- * of the template and they will become properties of the constructed menu items.
+ * Generally, the `template` is an array of `options` for constructing a MenuItem.
+ * The usage can be referenced above.
+ *
+ * You can also attach other fields to the element of the `template` and they will
+ * become properties of the constructed menu items.
*/
static buildFromTemplate(template: Array<(MenuItemConstructorOptions) | (MenuItem)>): Menu;
/**
- * Note: The returned Menu instance doesn't support dynamic addition or removal of
- * menu items. Instance properties can still be dynamically modified.
+ * The application menu, if set, or `null`, if not set.
+ *
+ * **Note:** The returned `Menu` instance doesn't support dynamic addition or
+ * removal of menu items. Instance properties can still be dynamically modified.
*/
static getApplicationMenu(): (Menu) | (null);
/**
- * Sends the action to the first responder of application. This is used for
- * emulating default macOS menu behaviors. Usually you would use the role property
- * of a MenuItem. See the macOS Cocoa Event Handling Guide for more information on
- * macOS' native actions.
+ * Sends the `action` to the first responder of application. This is used for
+ * emulating default macOS menu behaviors. Usually you would use the `role`
+ * property of a `MenuItem`.
+ *
+ * See the macOS Cocoa Event Handling Guide for more information on macOS' native
+ * actions.
*/
static sendActionToFirstResponder(action: string): void;
/**
- * Sets menu as the application menu on macOS. On Windows and Linux, the menu will
- * be set as each window's top menu. Also on Windows and Linux, you can use a & in
- * the top-level item name to indicate which letter should get a generated
- * accelerator. For example, using &File for the file menu would result in a
- * generated Alt-F accelerator that opens the associated menu. The indicated
- * character in the button label gets an underline. The & character is not
- * displayed on the button label. Passing null will suppress the default menu. On
- * Windows and Linux, this has the additional effect of removing the menu bar from
- * the window. Note: The default menu will be created automatically if the app does
- * not set one. It contains standard items such as File, Edit, View, Window and
- * Help.
+ * Sets `menu` as the application menu on macOS. On Windows and Linux, the `menu`
+ * will be set as each window's top menu.
+ *
+ * Also on Windows and Linux, you can use a `&` in the top-level item name to
+ * indicate which letter should get a generated accelerator. For example, using
+ * `&File` for the file menu would result in a generated `Alt-F` accelerator that
+ * opens the associated menu. The indicated character in the button label gets an
+ * underline. The `&` character is not displayed on the button label.
+ *
+ * Passing `null` will suppress the default menu. On Windows and Linux, this has
+ * the additional effect of removing the menu bar from the window.
+ *
+ * **Note:** The default menu will be created automatically if the app does not set
+ * one. It contains standard items such as `File`, `Edit`, `View`, `Window` and
+ * `Help`.
*/
static setApplicationMenu(menu: (Menu) | (null)): void;
/**
- * Appends the menuItem to the menu.
+ * Appends the `menuItem` to the menu.
*/
append(menuItem: MenuItem): void;
/**
- * Closes the context menu in the browserWindow.
+ * Closes the context menu in the `browserWindow`.
*/
closePopup(browserWindow?: BrowserWindow): void;
+ /**
+ * the item with the specified `id`
+ */
getMenuItemById(id: string): MenuItem;
/**
- * Inserts the menuItem to the pos position of the menu.
+ * Inserts the `menuItem` to the `pos` position of the menu.
*/
insert(pos: number, menuItem: MenuItem): void;
/**
- * Pops up this menu as a context menu in the BrowserWindow.
+ * Pops up this menu as a context menu in the `BrowserWindow`.
*/
popup(options?: PopupOptions): void;
items: MenuItem[];
@@ -3667,13 +4500,16 @@ declare namespace Electron {
// Docs: http://electronjs.org/docs/api/menu-item
+ /**
+ * MenuItem
+ */
constructor(options: MenuItemConstructorOptions);
accelerator: string;
checked: boolean;
click: Function;
commandId: number;
enabled: boolean;
- icon: NativeImage;
+ icon: (NativeImage) | (string);
id: string;
label: string;
menu: Menu;
@@ -3704,40 +4540,56 @@ declare namespace Electron {
// Docs: http://electronjs.org/docs/api/native-image
/**
- * Creates an empty NativeImage instance.
+ * Creates an empty `NativeImage` instance.
*/
static createEmpty(): NativeImage;
/**
- * Creates a new NativeImage instance from buffer that contains the raw bitmap
- * pixel data returned by toBitmap(). The specific format is platform-dependent.
+ * Creates a new `NativeImage` instance from `buffer` that contains the raw bitmap
+ * pixel data returned by `toBitmap()`. The specific format is platform-dependent.
*/
static createFromBitmap(buffer: Buffer, options: CreateFromBitmapOptions): NativeImage;
/**
- * Creates a new NativeImage instance from buffer. Tries to decode as PNG or JPEG
- * first.
+ * Creates a new `NativeImage` instance from `buffer`. Tries to decode as PNG or
+ * JPEG first.
*/
static createFromBuffer(buffer: Buffer, options?: CreateFromBufferOptions): NativeImage;
/**
- * Creates a new NativeImage instance from dataURL.
+ * Creates a new `NativeImage` instance from `dataURL`.
*/
static createFromDataURL(dataURL: string): NativeImage;
/**
- * Creates a new NativeImage instance from the NSImage that maps to the given image
- * name. See NSImageName for a list of possible values. The hslShift is applied to
- * the image with the following rules This means that [-1, 0, 1] will make the
- * image completely white and [-1, 1, 0] will make the image completely black. In
- * some cases, the NSImageName doesn't match its string representation; one example
- * of this is NSFolderImageName, whose string representation would actually be
- * NSFolder. Therefore, you'll need to determine the correct string representation
- * for your image before passing it in. This can be done with the following: echo
- * -e '#import <Cocoa/Cocoa.h>\nint main() { NSLog(@"%@", SYSTEM_IMAGE_NAME); }' |
- * clang -otest -x objective-c -framework Cocoa - && ./test where SYSTEM_IMAGE_NAME
- * should be replaced with any value from this list.
+ * Creates a new `NativeImage` instance from the NSImage that maps to the given
+ * image name. See `NSImageName` for a list of possible values.
+ *
+ * The `hslShift` is applied to the image with the following rules
+ *
+ * * `hsl_shift[0]` (hue): The absolute hue value for the image - 0 and 1 map to 0
+ * and 360 on the hue color wheel (red).
+ * * `hsl_shift[1]` (saturation): A saturation shift for the image, with the
+ * following key values: 0 = remove all color. 0.5 = leave unchanged. 1 = fully
+ * saturate the image.
+ * * `hsl_shift[2]` (lightness): A lightness shift for the image, with the
+ * following key values: 0 = remove all lightness (make all pixels black). 0.5 =
+ * leave unchanged. 1 = full lightness (make all pixels white).
+ *
+ * This means that `[-1, 0, 1]` will make the image completely white and `[-1, 1,
+ * 0]` will make the image completely black.
+ *
+ * In some cases, the `NSImageName` doesn't match its string representation; one
+ * example of this is `NSFolderImageName`, whose string representation would
+ * actually be `NSFolder`. Therefore, you'll need to determine the correct string
+ * representation for your image before passing it in. This can be done with the
+ * following:
+ *
+ * `echo -e '#import <Cocoa/Cocoa.h>\nint main() { NSLog(@"%@", SYSTEM_IMAGE_NAME);
+ * }' | clang -otest -x objective-c -framework Cocoa - && ./test`
+ *
+where `SYSTEM_IMAGE_NAME` should be replaced with any value from this list.
*/
static createFromNamedImage(imageName: string, hslShift: number[]): NativeImage;
/**
- * Creates a new NativeImage instance from a file located at path. This method
- * returns an empty image if the path does not exist, cannot be read, or is not a
+ * Creates a new `NativeImage` instance from a file located at `path`. This method
+ * returns an empty image if the `path` does not exist, cannot be read, or is not a
* valid image.
*/
static createFromPath(path: string): NativeImage;
@@ -3747,75 +4599,108 @@ declare namespace Electron {
* called on empty images.
*/
addRepresentation(options: AddRepresentationOptions): void;
+ /**
+ * The cropped image.
+ */
crop(rect: Rectangle): NativeImage;
+ /**
+ * The image's aspect ratio.
+ */
getAspectRatio(): number;
/**
- * The difference between getBitmap() and toBitmap() is, getBitmap() does not copy
- * the bitmap data, so you have to use the returned Buffer immediately in current
- * event loop tick, otherwise the data might be changed or destroyed.
+ * A Buffer that contains the image's raw bitmap pixel data.
+ *
+ * The difference between `getBitmap()` and `toBitmap()` is, `getBitmap()` does not
+ * copy the bitmap data, so you have to use the returned Buffer immediately in
+ * current event loop tick, otherwise the data might be changed or destroyed.
*/
getBitmap(options?: BitmapOptions): Buffer;
/**
+ * A Buffer that stores C pointer to underlying native handle of the image. On
+ * macOS, a pointer to `NSImage` instance would be returned.
+ *
* Notice that the returned pointer is a weak pointer to the underlying native
- * image instead of a copy, so you must ensure that the associated nativeImage
+ * image instead of a copy, so you _must_ ensure that the associated `nativeImage`
* instance is kept around.
*/
getNativeHandle(): Buffer;
getSize(): Size;
+ /**
+ * Whether the image is empty.
+ */
isEmpty(): boolean;
+ /**
+ * Whether the image is a template image.
+ */
isTemplateImage(): boolean;
/**
- * If only the height or the width are specified then the current aspect ratio will
- * be preserved in the resized image.
+ * The resized image.
+ *
+ * If only the `height` or the `width` are specified then the current aspect ratio
+ * will be preserved in the resized image.
*/
resize(options: ResizeOptions): NativeImage;
/**
* Marks the image as a template image.
*/
setTemplateImage(option: boolean): void;
+ /**
+ * A Buffer that contains a copy of the image's raw bitmap pixel data.
+ */
toBitmap(options?: ToBitmapOptions): Buffer;
+ /**
+ * The data URL of the image.
+ */
toDataURL(options?: ToDataURLOptions): string;
+ /**
+ * A Buffer that contains the image's `JPEG` encoded data.
+ */
toJPEG(quality: number): Buffer;
+ /**
+ * A Buffer that contains the image's `PNG` encoded data.
+ */
toPNG(options?: ToPNGOptions): Buffer;
}
- interface Net extends EventEmitter {
+ interface Net extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/net
/**
- * Creates a ClientRequest instance using the provided options which are directly
- * forwarded to the ClientRequest constructor. The net.request method would be used
- * to issue both secure and insecure HTTP requests according to the specified
- * protocol scheme in the options object.
+ * Creates a `ClientRequest` instance using the provided `options` which are
+ * directly forwarded to the `ClientRequest` constructor. The `net.request` method
+ * would be used to issue both secure and insecure HTTP requests according to the
+ * specified protocol scheme in the `options` object.
*/
request(options: (any) | (string)): ClientRequest;
}
- interface NetLog extends EventEmitter {
+ interface NetLog extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/net-log
/**
- * Starts recording network events to path.
+ * Starts recording network events to `path`.
*/
startLogging(path: string): void;
/**
+ * resolves with a file path to which network logs were recorded.
+ *
* Stops recording network events. If not called, net logging will automatically
* end when app quits.
*/
stopLogging(): Promise<string>;
/**
- * A Boolean property that indicates whether network logs are recorded.
+ * A `Boolean` property that indicates whether network logs are recorded.
*/
- currentlyLogging?: boolean;
+ currentlyLogging: boolean;
/**
- * A String property that returns the path to the current log file.
+ * A `String` property that returns the path to the current log file.
*/
- currentlyLoggingPath?: string;
+ currentlyLoggingPath: string;
}
- class Notification extends EventEmitter {
+ class Notification extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/notification
@@ -3848,6 +4733,7 @@ declare namespace Electron {
removeListener(event: 'click', listener: (event: Event) => void): this;
/**
* Emitted when the notification is closed by manual intervention from the user.
+ *
* This event is not guaranteed to be emitted in all cases where the notification
* is closed.
*/
@@ -3856,8 +4742,8 @@ declare namespace Electron {
addListener(event: 'close', listener: (event: Event) => void): this;
removeListener(event: 'close', listener: (event: Event) => void): this;
/**
- * Emitted when the user clicks the "Reply" button on a notification with hasReply:
- * true.
+ * Emitted when the user clicks the "Reply" button on a notification with
+ * `hasReply: true`.
*/
on(event: 'reply', listener: (event: Event,
/**
@@ -3881,14 +4767,20 @@ declare namespace Electron {
reply: string) => void): this;
/**
* Emitted when the notification is shown to the user, note this could be fired
- * multiple times as a notification can be shown multiple times through the show()
- * method.
+ * multiple times as a notification can be shown multiple times through the
+ * `show()` method.
*/
on(event: 'show', listener: (event: Event) => void): this;
once(event: 'show', listener: (event: Event) => void): this;
addListener(event: 'show', listener: (event: Event) => void): this;
removeListener(event: 'show', listener: (event: Event) => void): this;
+ /**
+ * Notification
+ */
constructor(options: NotificationConstructorOptions);
+ /**
+ * Whether or not desktop notifications are supported on the current system
+ */
static isSupported(): boolean;
/**
* Dismisses the notification.
@@ -3896,11 +4788,12 @@ declare namespace Electron {
close(): void;
/**
* Immediately shows the notification to the user, please note this means unlike
- * the HTML5 Notification implementation, instantiating a new Notification does not
- * immediately show it to the user, you need to call this method before the OS will
- * display it. If the notification has been shown before, this method will dismiss
- * the previously shown notification and create a new one with identical
- * properties.
+ * the HTML5 Notification implementation, instantiating a `new Notification` does
+ * not immediately show it to the user, you need to call this method before the OS
+ * will display it.
+ *
+ * If the notification has been shown before, this method will dismiss the
+ * previously shown notification and create a new one with identical properties.
*/
show(): void;
}
@@ -3914,7 +4807,7 @@ declare namespace Electron {
*/
text?: string;
/**
- * The type of action, can be button.
+ * The type of action, can be `button`.
*/
type: ('button');
}
@@ -3927,7 +4820,7 @@ declare namespace Electron {
y: number;
}
- interface PowerMonitor extends EventEmitter {
+ interface PowerMonitor extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/power-monitor
@@ -3961,9 +4854,9 @@ declare namespace Electron {
removeListener(event: 'resume', listener: Function): this;
/**
* Emitted when the system is about to reboot or shut down. If the event handler
- * invokes e.preventDefault(), Electron will attempt to delay system shutdown in
- * order for the app to exit cleanly. If e.preventDefault() is called, the app
- * should exit as soon as possible by calling something like app.quit().
+ * invokes `e.preventDefault()`, Electron will attempt to delay system shutdown in
+ * order for the app to exit cleanly. If `e.preventDefault()` is called, the app
+ * should exit as soon as possible by calling something like `app.quit()`.
*/
on(event: 'shutdown', listener: Function): this;
once(event: 'shutdown', listener: Function): this;
@@ -3984,19 +4877,24 @@ declare namespace Electron {
addListener(event: 'unlock-screen', listener: Function): this;
removeListener(event: 'unlock-screen', listener: Function): this;
/**
- * Calculate the system idle state. idleThreshold is the amount of time (in
- * seconds) before considered idle. locked is available on supported systems only.
+ * The system's current state. Can be `active`, `idle`, `locked` or `unknown`.
+ *
+ * Calculate the system idle state. `idleThreshold` is the amount of time (in
+ * seconds) before considered idle. `locked` is available on supported systems
+ * only.
*/
getSystemIdleState(idleThreshold: number): ('active' | 'idle' | 'locked' | 'unknown');
/**
- * Calculate system idle time in seconds.
+ * Idle time in seconds
+
+Calculate system idle time in seconds.
*/
getSystemIdleTime(): number;
/**
- * Calculate the system idle state. idleThreshold is the amount of time (in
- * seconds) before considered idle. callback will be called synchronously on some
- * systems and with an idleState argument that describes the system's state. locked
- * is available on supported systems only.
+ * Calculate the system idle state. `idleThreshold` is the amount of time (in
+ * seconds) before considered idle. `callback` will be called synchronously on some
+ * systems and with an `idleState` argument that describes the system's state.
+ * `locked` is available on supported systems only.
*/
querySystemIdleState(idleThreshold: number, callback: (idleState: 'active' | 'idle' | 'locked' | 'unknown') => void): void;
/**
@@ -4005,20 +4903,28 @@ declare namespace Electron {
querySystemIdleTime(callback: (idleTime: number) => void): void;
}
- interface PowerSaveBlocker extends EventEmitter {
+ interface PowerSaveBlocker extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/power-save-blocker
+ /**
+ * Whether the corresponding `powerSaveBlocker` has started.
+ */
isStarted(id: number): boolean;
/**
+ * The blocker ID that is assigned to this power blocker.
+ *
* Starts preventing the system from entering lower-power mode. Returns an integer
- * identifying the power save blocker. Note: prevent-display-sleep has higher
- * precedence over prevent-app-suspension. Only the highest precedence type takes
- * effect. In other words, prevent-display-sleep always takes precedence over
- * prevent-app-suspension. For example, an API calling A requests for
- * prevent-app-suspension, and another calling B requests for
- * prevent-display-sleep. prevent-display-sleep will be used until B stops its
- * request. After that, prevent-app-suspension is used.
+ * identifying the power save blocker.
+ *
+ * **Note:** `prevent-display-sleep` has higher precedence over
+ * `prevent-app-suspension`. Only the highest precedence type takes effect. In
+ * other words, `prevent-display-sleep` always takes precedence over
+ * `prevent-app-suspension`.
+ *
+ * For example, an API calling A requests for `prevent-app-suspension`, and another
+ * calling B requests for `prevent-display-sleep`. `prevent-display-sleep` will be
+ * used until B stops its request. After that, `prevent-app-suspension` is used.
*/
start(type: 'prevent-app-suspension' | 'prevent-display-sleep'): number;
/**
@@ -4047,7 +4953,8 @@ declare namespace Electron {
*/
private: number;
/**
- * and The amount of memory currently pinned to actual physical RAM in Kilobytes.
+ * _Linux_ and _Windows_ - The amount of memory currently pinned to actual physical
+ * RAM in Kilobytes.
*/
residentSet: number;
/**
@@ -4114,116 +5021,153 @@ declare namespace Electron {
productIdentifier: string;
}
- interface Protocol extends EventEmitter {
+ interface Protocol extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/protocol
/**
- * Intercepts scheme protocol and uses handler as the protocol's new handler which
- * sends a Buffer as a response.
+ * Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
+ * which sends a `Buffer` as a response.
*/
- interceptBufferProtocol(scheme: string, handler: (request: InterceptBufferProtocolRequest, callback: (buffer?: Buffer) => void) => void, completion?: (error: Error) => void): void;
+ interceptBufferProtocol(scheme: string, handler: (request: HandlerRequest, callback: (buffer?: Buffer) => void) => void, completion?: (error: Error) => void): void;
/**
- * Intercepts scheme protocol and uses handler as the protocol's new handler which
- * sends a file as a response.
+ * Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
+ * which sends a file as a response.
*/
- interceptFileProtocol(scheme: string, handler: (request: InterceptFileProtocolRequest, callback: (filePath: string) => void) => void, completion?: (error: Error) => void): void;
+ interceptFileProtocol(scheme: string, handler: (request: HandlerRequest, callback: (filePath: string) => void) => void, completion?: (error: Error) => void): void;
/**
- * Intercepts scheme protocol and uses handler as the protocol's new handler which
- * sends a new HTTP request as a response.
+ * Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
+ * which sends a new HTTP request as a response.
*/
- interceptHttpProtocol(scheme: string, handler: (request: InterceptHttpProtocolRequest, callback: (redirectRequest: RedirectRequest) => void) => void, completion?: (error: Error) => void): void;
+ interceptHttpProtocol(scheme: string, handler: (request: HandlerRequest, callback: (redirectRequest: RedirectRequest) => void) => void, completion?: (error: Error) => void): void;
/**
- * Same as protocol.registerStreamProtocol, except that it replaces an existing
+ * Same as `protocol.registerStreamProtocol`, except that it replaces an existing
* protocol handler.
*/
- interceptStreamProtocol(scheme: string, handler: (request: InterceptStreamProtocolRequest, callback: (stream?: (NodeJS.ReadableStream) | (StreamProtocolResponse)) => void) => void, completion?: (error: Error) => void): void;
+ interceptStreamProtocol(scheme: string, handler: (request: HandlerRequest, callback: (stream?: (NodeJS.ReadableStream) | (StreamProtocolResponse)) => void) => void, completion?: (error: Error) => void): void;
+ /**
+ * Intercepts `scheme` protocol and uses `handler` as the protocol's new handler
+ * which sends a `String` as a response.
+ */
+ interceptStringProtocol(scheme: string, handler: (request: HandlerRequest, callback: (data?: string) => void) => void, completion?: (error: Error) => void): void;
/**
- * Intercepts scheme protocol and uses handler as the protocol's new handler which
- * sends a String as a response.
+ * fulfilled with a boolean that indicates whether there is already a handler for
+ * `scheme`.
*/
- interceptStringProtocol(scheme: string, handler: (request: InterceptStringProtocolRequest, callback: (data?: string) => void) => void, completion?: (error: Error) => void): void;
isProtocolHandled(scheme: string): Promise<boolean>;
/**
- * Registers a protocol of scheme that will send a Buffer as a response. The usage
- * is the same with registerFileProtocol, except that the callback should be called
- * with either a Buffer object or an object that has the data, mimeType, and
- * charset properties. Example:
- */
- registerBufferProtocol(scheme: string, handler: (request: RegisterBufferProtocolRequest, callback: (buffer?: (Buffer) | (MimeTypedBuffer)) => void) => void, completion?: (error: Error) => void): void;
- /**
- * Registers a protocol of scheme that will send the file as a response. The
- * handler will be called with handler(request, callback) when a request is going
- * to be created with scheme. completion will be called with completion(null) when
- * scheme is successfully registered or completion(error) when failed. To handle
- * the request, the callback should be called with either the file's path or an
- * object that has a path property, e.g. callback(filePath) or callback({ path:
- * filePath }). The object may also have a headers property which gives a map of
- * headers to values for the response headers, e.g. callback({ path: filePath,
- * headers: {"Content-Security-Policy": "default-src 'none'"]}). When callback is
- * called with nothing, a number, or an object that has an error property, the
- * request will fail with the error number you specified. For the available error
- * numbers you can use, please see the net error list. By default the scheme is
- * treated like http:, which is parsed differently than protocols that follow the
- * "generic URI syntax" like file:.
- */
- registerFileProtocol(scheme: string, handler: (request: RegisterFileProtocolRequest, callback: (filePath?: string) => void) => void, completion?: (error: Error) => void): void;
- /**
- * Registers a protocol of scheme that will send an HTTP request as a response. The
- * usage is the same with registerFileProtocol, except that the callback should be
- * called with a redirectRequest object that has the url, method, referrer,
- * uploadData and session properties. By default the HTTP request will reuse the
- * current session. If you want the request to have a different session you should
- * set session to null. For POST requests the uploadData object must be provided.
- */
- registerHttpProtocol(scheme: string, handler: (request: RegisterHttpProtocolRequest, callback: (redirectRequest: RedirectRequest) => void) => void, completion?: (error: Error) => void): void;
- /**
- * Note: This method can only be used before the ready event of the app module gets
- * emitted and can be called only once. Registers the scheme as standard, secure,
- * bypasses content security policy for resources, allows registering ServiceWorker
- * and supports fetch API. Specify a privilege with the value of true to enable the
- * capability. An example of registering a privileged scheme, with bypassing
- * Content Security Policy: A standard scheme adheres to what RFC 3986 calls
- * generic URI syntax. For example http and https are standard schemes, while file
- * is not. Registering a scheme as standard, will allow relative and absolute
- * resources to be resolved correctly when served. Otherwise the scheme will behave
- * like the file protocol, but without the ability to resolve relative URLs. For
- * example when you load following page with custom protocol without registering it
- * as standard scheme, the image will not be loaded because non-standard schemes
- * can not recognize relative URLs: Registering a scheme as standard will allow
- * access to files through the FileSystem API. Otherwise the renderer will throw a
- * security error for the scheme. By default web storage apis (localStorage,
- * sessionStorage, webSQL, indexedDB, cookies) are disabled for non standard
- * schemes. So in general if you want to register a custom protocol to replace the
- * http protocol, you have to register it as a standard scheme.
- * protocol.registerSchemesAsPrivileged can be used to replicate the functionality
- * of the previous protocol.registerStandardSchemes, webFrame.registerURLSchemeAs*
- * and protocol.registerServiceWorkerSchemes functions that existed prior to
- * Electron 5.0.0, for example: before (<= v4.x) after (>= v5.x)
+ * Registers a protocol of `scheme` that will send a `Buffer` as a response.
+ *
+ * The usage is the same with `registerFileProtocol`, except that the `callback`
+ * should be called with either a `Buffer` object or an object that has the `data`,
+ * `mimeType`, and `charset` properties.
+
+Example:
+ */
+ registerBufferProtocol(scheme: string, handler: (request: HandlerRequest, callback: (buffer?: (Buffer) | (MimeTypedBuffer)) => void) => void, completion?: (error: Error) => void): void;
+ /**
+ * Registers a protocol of `scheme` that will send the file as a response. The
+ * `handler` will be called with `handler(request, callback)` when a `request` is
+ * going to be created with `scheme`. `completion` will be called with
+ * `completion(null)` when `scheme` is successfully registered or
+ * `completion(error)` when failed.
+ *
+ * To handle the `request`, the `callback` should be called with either the file's
+ * path or an object that has a `path` property, e.g. `callback(filePath)` or
+ * `callback({ path: filePath })`. The object may also have a `headers` property
+ * which gives a map of headers to values for the response headers, e.g.
+ * `callback({ path: filePath, headers: {"Content-Security-Policy": "default-src
+ * 'none'"]})`.
+ *
+ * When `callback` is called with nothing, a number, or an object that has an
+ * `error` property, the `request` will fail with the `error` number you specified.
+ * For the available error numbers you can use, please see the net error list.
+ *
+ * By default the `scheme` is treated like `http:`, which is parsed differently
+ * than protocols that follow the "generic URI syntax" like `file:`.
+ */
+ registerFileProtocol(scheme: string, handler: (request: HandlerRequest, callback: (filePath?: string) => void) => void, completion?: (error: Error) => void): void;
+ /**
+ * Registers a protocol of `scheme` that will send an HTTP request as a response.
+ *
+ * The usage is the same with `registerFileProtocol`, except that the `callback`
+ * should be called with a `redirectRequest` object that has the `url`, `method`,
+ * `referrer`, `uploadData` and `session` properties.
+ *
+ * By default the HTTP request will reuse the current session. If you want the
+ * request to have a different session you should set `session` to `null`.
+ *
+For POST requests the `uploadData` object must be provided.
+ */
+ registerHttpProtocol(scheme: string, handler: (request: HandlerRequest, callback: (redirectRequest: RedirectRequest) => void) => void, completion?: (error: Error) => void): void;
+ /**
+ * **Note:** This method can only be used before the `ready` event of the `app`
+ * module gets emitted and can be called only once.
+ *
+ * Registers the `scheme` as standard, secure, bypasses content security policy for
+ * resources, allows registering ServiceWorker and supports fetch API.
+ *
+ * Specify a privilege with the value of `true` to enable the capability. An
+ * example of registering a privileged scheme, with bypassing Content Security
+ * Policy:
+ *
+ * A standard scheme adheres to what RFC 3986 calls generic URI syntax. For example
+ * `http` and `https` are standard schemes, while `file` is not.
+ *
+ * Registering a scheme as standard, will allow relative and absolute resources to
+ * be resolved correctly when served. Otherwise the scheme will behave like the
+ * `file` protocol, but without the ability to resolve relative URLs.
+ *
+ * For example when you load following page with custom protocol without
+ * registering it as standard scheme, the image will not be loaded because
+ * non-standard schemes can not recognize relative URLs:
+ *
+ * Registering a scheme as standard will allow access to files through the
+ * FileSystem API. Otherwise the renderer will throw a security error for the
+ * scheme.
+ *
+ * By default web storage apis (localStorage, sessionStorage, webSQL, indexedDB,
+ * cookies) are disabled for non standard schemes. So in general if you want to
+ * register a custom protocol to replace the `http` protocol, you have to register
+ * it as a standard scheme.
+ *
+ * `protocol.registerSchemesAsPrivileged` can be used to replicate the
+ * functionality of the previous `protocol.registerStandardSchemes`,
+ * `webFrame.registerURLSchemeAs*` and `protocol.registerServiceWorkerSchemes`
+ * functions that existed prior to Electron 5.0.0, for example:
+ *
+**before (<= v4.x)**
+
+**after (>= v5.x)**
*/
registerSchemesAsPrivileged(customSchemes: CustomScheme[]): void;
/**
- * Registers a protocol of scheme that will send a Readable as a response. The
- * usage is similar to the other register{Any}Protocol, except that the callback
- * should be called with either a Readable object or an object that has the data,
- * statusCode, and headers properties. Example: It is possible to pass any object
- * that implements the readable stream API (emits data/end/error events). For
- * example, here's how a file could be returned:
+ * Registers a protocol of `scheme` that will send a `Readable` as a response.
+ *
+ * The usage is similar to the other `register{Any}Protocol`, except that the
+ * `callback` should be called with either a `Readable` object or an object that
+ * has the `data`, `statusCode`, and `headers` properties.
+ *
+ * Example:
+ *
+ * It is possible to pass any object that implements the readable stream API (emits
+ * `data`/`end`/`error` events). For example, here's how a file could be returned:
*/
- registerStreamProtocol(scheme: string, handler: (request: RegisterStreamProtocolRequest, callback: (stream?: (NodeJS.ReadableStream) | (StreamProtocolResponse)) => void) => void, completion?: (error: Error) => void): void;
+ registerStreamProtocol(scheme: string, handler: (request: HandlerRequest, callback: (stream?: (NodeJS.ReadableStream) | (StreamProtocolResponse)) => void) => void, completion?: (error: Error) => void): void;
/**
- * Registers a protocol of scheme that will send a String as a response. The usage
- * is the same with registerFileProtocol, except that the callback should be called
- * with either a String or an object that has the data, mimeType, and charset
- * properties.
+ * Registers a protocol of `scheme` that will send a `String` as a response.
+ *
+ * The usage is the same with `registerFileProtocol`, except that the `callback`
+ * should be called with either a `String` or an object that has the `data`,
+ * `mimeType`, and `charset` properties.
*/
- registerStringProtocol(scheme: string, handler: (request: RegisterStringProtocolRequest, callback: (data?: string) => void) => void, completion?: (error: Error) => void): void;
+ registerStringProtocol(scheme: string, handler: (request: HandlerRequest, callback: (data?: string) => void) => void, completion?: (error: Error) => void): void;
/**
- * Remove the interceptor installed for scheme and restore its original handler.
+ * Remove the interceptor installed for `scheme` and restore its original handler.
*/
uninterceptProtocol(scheme: string, completion?: (error: Error) => void): void;
/**
- * Unregisters the custom protocol of scheme.
+ * Unregisters the custom protocol of `scheme`.
*/
unregisterProtocol(scheme: string, completion?: (error: Error) => void): void;
}
@@ -4255,9 +5199,9 @@ declare namespace Electron {
// Docs: http://electronjs.org/docs/api/structures/referrer
/**
- * Can be default, unsafe-url, no-referrer-when-downgrade, no-referrer, origin,
- * strict-origin-when-cross-origin, same-origin or strict-origin. See the for more
- * details on the meaning of these values.
+ * Can be `default`, `unsafe-url`, `no-referrer-when-downgrade`, `no-referrer`,
+ * `origin`, `strict-origin-when-cross-origin`, `same-origin` or `strict-origin`.
+ * See the Referrer-Policy spec for more details on the meaning of these values.
*/
policy: ('default' | 'unsafe-url' | 'no-referrer-when-downgrade' | 'no-referrer' | 'origin' | 'strict-origin-when-cross-origin' | 'same-origin' | 'strict-origin');
/**
@@ -4270,23 +5214,35 @@ declare namespace Electron {
// Docs: http://electronjs.org/docs/api/remote
+ /**
+ * The web contents of this web page.
+ */
getCurrentWebContents(): WebContents;
/**
- * Note: Do not use removeAllListeners on BrowserWindow. Use of this can remove all
- * blur listeners, disable click events on touch bar buttons, and other unintended
- * consequences.
+ * The window to which this web page belongs.
+ *
+ * **Note:** Do not use `removeAllListeners` on `BrowserWindow`. Use of this can
+ * remove all `blur` listeners, disable click events on touch bar buttons, and
+ * other unintended consequences.
*/
getCurrentWindow(): BrowserWindow;
+ /**
+ * The global variable of `name` (e.g. `global[name]`) in the main process.
+ */
getGlobal(name: string): any;
/**
- * e.g.
+ * The object returned by `require(module)` in the main process. Modules specified
+ * by their relative path will resolve relative to the entrypoint of the main
+ * process.
+
+e.g.
*/
require(module: string): any;
/**
- * The process object in the main process. This is the same as
- * remote.getGlobal('process') but is cached.
+ * A `NodeJS.Process` object. The `process` object in the main process. This is
+ * the same as `remote.getGlobal('process')` but is cached.
*/
- process?: any;
+ process: NodeJS.Process;
}
interface RemoveClientCertificate {
@@ -4299,7 +5255,7 @@ declare namespace Electron {
*/
origin: string;
/**
- * clientCertificate.
+ * `clientCertificate`.
*/
type: string;
}
@@ -4314,34 +5270,34 @@ declare namespace Electron {
*/
origin?: string;
/**
- * Credentials of the authentication. Must be provided if removing by origin.
+ * Credentials of the authentication. Must be provided if removing by `origin`.
*/
password?: string;
/**
- * Realm of the authentication. Must be provided if removing by origin.
+ * Realm of the authentication. Must be provided if removing by `origin`.
*/
realm?: string;
/**
- * Scheme of the authentication. Can be basic, digest, ntlm, negotiate. Must be
- * provided if removing by origin.
+ * Scheme of the authentication. Can be `basic`, `digest`, `ntlm`, `negotiate`.
+ * Must be provided if removing by `origin`.
*/
scheme?: ('basic' | 'digest' | 'ntlm' | 'negotiate');
/**
- * password.
+ * `password`.
*/
type: string;
/**
- * Credentials of the authentication. Must be provided if removing by origin.
+ * Credentials of the authentication. Must be provided if removing by `origin`.
*/
username?: string;
}
- interface Screen extends EventEmitter {
+ interface Screen extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/screen
/**
- * Emitted when newDisplay has been added.
+ * Emitted when `newDisplay` has been added.
*/
on(event: 'display-added', listener: (event: Event,
newDisplay: Display) => void): this;
@@ -4352,9 +5308,9 @@ declare namespace Electron {
removeListener(event: 'display-added', listener: (event: Event,
newDisplay: Display) => void): this;
/**
- * Emitted when one or more metrics change in a display. The changedMetrics is an
- * array of strings that describe the changes. Possible changes are bounds,
- * workArea, scaleFactor and rotation.
+ * Emitted when one or more metrics change in a `display`. The `changedMetrics` is
+ * an array of strings that describe the changes. Possible changes are `bounds`,
+ * `workArea`, `scaleFactor` and `rotation`.
*/
on(event: 'display-metrics-changed', listener: (event: Event,
display: Display,
@@ -4369,7 +5325,7 @@ declare namespace Electron {
display: Display,
changedMetrics: string[]) => void): this;
/**
- * Emitted when oldDisplay has been removed.
+ * Emitted when `oldDisplay` has been removed.
*/
on(event: 'display-removed', listener: (event: Event,
oldDisplay: Display) => void): this;
@@ -4386,17 +5342,29 @@ declare namespace Electron {
dipToScreenPoint(point: Point): Point;
/**
* Converts a screen DIP rect to a screen physical rect. The DPI scale is performed
- * relative to the display nearest to window. If window is null, scaling will be
- * performed to the display nearest to rect.
+ * relative to the display nearest to `window`. If `window` is null, scaling will
+ * be performed to the display nearest to `rect`.
*/
dipToScreenRect(window: (BrowserWindow) | (null), rect: Rectangle): Rectangle;
+ /**
+ * An array of displays that are currently available.
+ */
getAllDisplays(): Display[];
/**
* The current absolute position of the mouse pointer.
*/
getCursorScreenPoint(): Point;
+ /**
+ * The display that most closely intersects the provided bounds.
+ */
getDisplayMatching(rect: Rectangle): Display;
+ /**
+ * The display nearest the specified point.
+ */
getDisplayNearestPoint(point: Point): Display;
+ /**
+ * The primary display.
+ */
getPrimaryDisplay(): Display;
/**
* Converts a screen physical point to a screen DIP point. The DPI scale is
@@ -4405,8 +5373,8 @@ declare namespace Electron {
screenToDipPoint(point: Point): Point;
/**
* Converts a screen physical rect to a screen DIP rect. The DPI scale is performed
- * relative to the display nearest to window. If window is null, scaling will be
- * performed to the display nearest to rect.
+ * relative to the display nearest to `window`. If `window` is null, scaling will
+ * be performed to the display nearest to `rect`.
*/
screenToDipRect(window: (BrowserWindow) | (null), rect: Rectangle): Rectangle;
}
@@ -4443,27 +5411,34 @@ declare namespace Electron {
label?: string;
}
- class Session extends EventEmitter {
+ class Session extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/session
/**
- * If partition starts with persist:, the page will use a persistent session
- * available to all pages in the app with the same partition. if there is no
- * persist: prefix, the page will use an in-memory session. If the partition is
- * empty then default session of the app will be returned. To create a Session with
- * options, you have to ensure the Session with the partition has never been used
- * before. There is no way to change the options of an existing Session object.
+ * A session instance from `partition` string. When there is an existing `Session`
+ * with the same `partition`, it will be returned; otherwise a new `Session`
+ * instance will be created with `options`.
+ *
+ * If `partition` starts with `persist:`, the page will use a persistent session
+ * available to all pages in the app with the same `partition`. if there is no
+ * `persist:` prefix, the page will use an in-memory session. If the `partition` is
+ * empty then default session of the app will be returned.
+ *
+ * To create a `Session` with `options`, you have to ensure the `Session` with the
+ * `partition` has never been used before. There is no way to change the `options`
+ * of an existing `Session` object.
*/
static fromPartition(partition: string, options?: FromPartitionOptions): Session;
/**
- * A Session object, the default session object of the app.
+ * A `Session` object, the default session object of the app.
*/
- static defaultSession?: Session;
+ static defaultSession: Session;
/**
- * Emitted when Electron is about to download item in webContents. Calling
- * event.preventDefault() will cancel the download and item will not be available
- * from next tick of the process.
+ * Emitted when Electron is about to download `item` in `webContents`.
+ *
+ * Calling `event.preventDefault()` will cancel the download and `item` will not be
+ * available from next tick of the process.
*/
on(event: 'will-download', listener: (event: Event,
item: DownloadItem,
@@ -4482,86 +5457,166 @@ declare namespace Electron {
* authentication.
*/
allowNTLMCredentialsForDomains(domains: string): void;
+ /**
+ * resolves when the session’s HTTP authentication cache has been cleared.
+ */
clearAuthCache(options: (RemovePassword) | (RemoveClientCertificate)): Promise<void>;
/**
- * Clears the session’s HTTP cache.
+ * resolves when the cache clear operation is complete.
+ *
+Clears the session’s HTTP cache.
*/
clearCache(): Promise<void>;
/**
- * Clears the host resolver cache.
+ * Resolves when the operation is complete.
+
+Clears the host resolver cache.
*/
clearHostResolverCache(): Promise<void>;
+ /**
+ * resolves when the storage data has been cleared.
+ */
clearStorageData(options?: ClearStorageDataOptions): Promise<void>;
/**
- * Allows resuming cancelled or interrupted downloads from previous Session. The
- * API will generate a DownloadItem that can be accessed with the will-download
- * event. The DownloadItem will not have any WebContents associated with it and the
- * initial state will be interrupted. The download will start only when the resume
- * API is called on the DownloadItem.
+ * Allows resuming `cancelled` or `interrupted` downloads from previous `Session`.
+ * The API will generate a DownloadItem that can be accessed with the will-download
+ * event. The DownloadItem will not have any `WebContents` associated with it and
+ * the initial state will be `interrupted`. The download will start only when the
+ * `resume` API is called on the DownloadItem.
*/
createInterruptedDownload(options: CreateInterruptedDownloadOptions): void;
/**
- * Disables any network emulation already active for the session. Resets to the
+ * Disables any network emulation already active for the `session`. Resets to the
* original network configuration.
*/
disableNetworkEmulation(): void;
/**
- * Emulates network with the given configuration for the session.
+ * Emulates network with the given configuration for the `session`.
*/
enableNetworkEmulation(options: EnableNetworkEmulationOptions): void;
/**
* Writes any unwritten DOMStorage data to disk.
*/
flushStorageData(): void;
+ /**
+ * resolves with blob data.
+ */
getBlobData(identifier: string): Promise<Buffer>;
+ /**
+ * the session's current cache size, in bytes.
+ */
getCacheSize(): Promise<number>;
+ /**
+ * an array of paths to preload scripts that have been registered.
+ */
getPreloads(): string[];
+ /**
+ * The user agent for this session.
+ */
getUserAgent(): string;
+ /**
+ * Resolves with the proxy information for `url`.
+ */
resolveProxy(url: string): Promise<string>;
/**
- * Sets the certificate verify proc for session, the proc will be called with
- * proc(request, callback) whenever a server certificate verification is requested.
- * Calling callback(0) accepts the certificate, calling callback(-2) rejects it.
- * Calling setCertificateVerifyProc(null) will revert back to default certificate
+ * Sets the certificate verify proc for `session`, the `proc` will be called with
+ * `proc(request, callback)` whenever a server certificate verification is
+ * requested. Calling `callback(0)` accepts the certificate, calling `callback(-2)`
+ * rejects it.
+ *
+ * Calling `setCertificateVerifyProc(null)` will revert back to default certificate
* verify proc.
*/
- setCertificateVerifyProc(proc: (request: CertificateVerifyProcRequest, callback: (verificationResult: number) => void) => void): void;
+ setCertificateVerifyProc(proc: (request: ProcRequest, callback: (verificationResult: number) => void) => void): void;
/**
* Sets download saving directory. By default, the download directory will be the
- * Downloads under the respective app folder.
+ * `Downloads` under the respective app folder.
*/
setDownloadPath(path: string): void;
/**
* Sets the handler which can be used to respond to permission checks for the
- * session. Returning true will allow the permission and false will reject it. To
- * clear the handler, call setPermissionCheckHandler(null).
+ * `session`. Returning `true` will allow the permission and `false` will reject
+ * it. To clear the handler, call `setPermissionCheckHandler(null)`.
*/
- setPermissionCheckHandler(handler: ((webContents: WebContents, permission: string, requestingOrigin: string, details: PermissionCheckHandlerDetails) => boolean) | (null)): void;
+ setPermissionCheckHandler(handler: (() => boolean) | (null)): void;
/**
* Sets the handler which can be used to respond to permission requests for the
- * session. Calling callback(true) will allow the permission and callback(false)
- * will reject it. To clear the handler, call setPermissionRequestHandler(null).
+ * `session`. Calling `callback(true)` will allow the permission and
+ * `callback(false)` will reject it. To clear the handler, call
+ * `setPermissionRequestHandler(null)`.
*/
- setPermissionRequestHandler(handler: ((webContents: WebContents, permission: string, callback: (permissionGranted: boolean) => void, details: PermissionRequestHandlerDetails) => void) | (null)): void;
+ setPermissionRequestHandler(handler: ((webContents: WebContents, permission: string, callback: (permissionGranted: boolean) => void, details: PermissionRequestHandlerHandlerDetails) => void) | (null)): void;
/**
* Adds scripts that will be executed on ALL web contents that are associated with
- * this session just before normal preload scripts run. Note: For security reasons,
- * preload scripts can only be loaded from a subpath of the app path.
+ * this session just before normal `preload` scripts run.
+ *
+ * **Note:** For security reasons, preload scripts can only be loaded from a
+ * subpath of the app path.
*/
setPreloads(preloads: string[]): void;
/**
- * Sets the proxy settings. When pacScript and proxyRules are provided together,
- * the proxyRules option is ignored and pacScript configuration is applied. The
- * proxyRules has to follow the rules below: For example: The proxyBypassRules is a
- * comma separated list of rules described below:
+ * Resolves when the proxy setting process is complete.
+ *
+ * Sets the proxy settings.
+ *
+ * When `pacScript` and `proxyRules` are provided together, the `proxyRules` option
+ * is ignored and `pacScript` configuration is applied.
+ *
+ * The `proxyRules` has to follow the rules below:
+ *
+ * For example:
+ *
+ * * `http=foopy:80;ftp=foopy2` - Use HTTP proxy `foopy:80` for `http://` URLs, and
+ * HTTP proxy `foopy2:80` for `ftp://` URLs.
+ * * `foopy:80` - Use HTTP proxy `foopy:80` for all URLs.
+ * * `foopy:80,bar,direct://` - Use HTTP proxy `foopy:80` for all URLs, failing
+ * over to `bar` if `foopy:80` is unavailable, and after that using no proxy.
+ * * `socks4://foopy` - Use SOCKS v4 proxy `foopy:1080` for all URLs.
+ * * `http=foopy,socks5://bar.com` - Use HTTP proxy `foopy` for http URLs, and fail
+ * over to the SOCKS5 proxy `bar.com` if `foopy` is unavailable.
+ * * `http=foopy,direct://` - Use HTTP proxy `foopy` for http URLs, and use no
+ * proxy if `foopy` is unavailable.
+ * * `http=foopy;socks=foopy2` - Use HTTP proxy `foopy` for http URLs, and use
+ * `socks4://foopy2` for all other URLs.
+ *
+ * The `proxyBypassRules` is a comma separated list of rules described below:
+ *
+ * * `[ URL_SCHEME "://" ] HOSTNAME_PATTERN [ ":" <port> ]`
+ *
+ * Match all hostnames that match the pattern HOSTNAME_PATTERN.
+ *
+ * Examples: "foobar.com", "*foobar.com", "*.foobar.com", "*foobar.com:99",
+ * "https://x.*.y.com:99"
+ * * `"." HOSTNAME_SUFFIX_PATTERN [ ":" PORT ]`
+ *
+ * Match a particular domain suffix.
+ *
+ * Examples: ".google.com", ".com", "http://.google.com"
+ * * `[ SCHEME "://" ] IP_LITERAL [ ":" PORT ]`
+ *
+ * Match URLs which are IP address literals.
+ *
+ * Examples: "127.0.1", "[0:0::1]", "[::1]", "http://[::1]:99"
+ * * `IP_LITERAL "/" PREFIX_LENGTH_IN_BITS`
+ *
+ * Match any URL that is to an IP literal that falls between the given range. IP
+ * range is specified using CIDR notation.
+ *
+ * Examples: "192.168.1.1/16", "fefe:13::abc/33".
+ * * `<local>`
+ *
+ * Match local addresses. The meaning of `<local>` is whether the host matches one
+ * of: "127.0.0.1", "::1", "localhost".
*/
setProxy(config: Config): Promise<void>;
/**
- * Overrides the userAgent and acceptLanguages for this session. The
- * acceptLanguages must a comma separated ordered list of language codes, for
- * example "en-US,fr,de,ko,zh-CN,ja". This doesn't affect existing WebContents, and
- * each WebContents can use webContents.setUserAgent to override the session-wide
- * user agent.
+ * Overrides the `userAgent` and `acceptLanguages` for this session.
+ *
+ * The `acceptLanguages` must a comma separated ordered list of language codes, for
+ * example `"en-US,fr,de,ko,zh-CN,ja"`.
+ *
+ * This doesn't affect existing `WebContents`, and each `WebContents` can use
+ * `webContents.setUserAgent` to override the session-wide user agent.
*/
setUserAgent(userAgent: string, acceptLanguages?: string): void;
cookies: Cookies;
@@ -4579,7 +5634,9 @@ declare namespace Electron {
*/
beep(): void;
/**
- * Move the given file to trash and returns a boolean status for the operation.
+ * Whether the item was successfully moved to the trash.
+ *
+Move the given file to trash and returns a boolean status for the operation.
*/
moveItemToTrash(fullPath: string): boolean;
/**
@@ -4588,17 +5645,22 @@ declare namespace Electron {
*/
openExternal(url: string, options?: OpenExternalOptions): Promise<void>;
/**
+ * Whether an application was available to open the URL.
+ *
* Open the given external protocol URL in the desktop's default manner. (For
* example, mailto: URLs in the user's default mail agent).
*/
openExternalSync(url: string, options?: OpenExternalSyncOptions): boolean;
/**
- * Open the given file in the desktop's default manner.
+ * Whether the item was successfully opened.
+ *
+Open the given file in the desktop's default manner.
*/
openItem(fullPath: string): boolean;
/**
- * Resolves the shortcut link at shortcutPath. An exception will be thrown when any
- * error happens.
+ * Resolves the shortcut link at `shortcutPath`.
+ *
+An exception will be thrown when any error happens.
*/
readShortcutLink(shortcutPath: string): ShortcutDetails;
/**
@@ -4606,11 +5668,15 @@ declare namespace Electron {
*/
showItemInFolder(fullPath: string): void;
/**
- * Creates or updates a shortcut link at shortcutPath.
+ * Whether the shortcut was created successfully.
+ *
+Creates or updates a shortcut link at `shortcutPath`.
*/
writeShortcutLink(shortcutPath: string, operation: 'create' | 'update' | 'replace', options: ShortcutDetails): boolean;
/**
- * Creates or updates a shortcut link at shortcutPath.
+ * Whether the shortcut was created successfully.
+ *
+Creates or updates a shortcut link at `shortcutPath`.
*/
writeShortcutLink(shortcutPath: string, options: ShortcutDetails): boolean;
}
@@ -4624,8 +5690,8 @@ declare namespace Electron {
*/
appUserModelId?: string;
/**
- * The arguments to be applied to target when launching from this shortcut. Default
- * is empty.
+ * The arguments to be applied to `target` when launching from this shortcut.
+ * Default is empty.
*/
args?: string;
/**
@@ -4637,12 +5703,12 @@ declare namespace Electron {
*/
description?: string;
/**
- * The path to the icon, can be a DLL or EXE. icon and iconIndex have to be set
+ * The path to the icon, can be a DLL or EXE. `icon` and `iconIndex` have to be set
* together. Default is empty, which uses the target's icon.
*/
icon?: string;
/**
- * The resource ID of icon when icon is a DLL or EXE. Default is 0.
+ * The resource ID of icon when `icon` is a DLL or EXE. Default is 0.
*/
iconIndex?: number;
/**
@@ -4677,7 +5743,7 @@ declare namespace Electron {
statusCode: number;
}
- interface SystemPreferences extends EventEmitter {
+ interface SystemPreferences extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/system-preferences
@@ -4702,8 +5768,8 @@ declare namespace Electron {
*/
newColor: string) => void): this;
/**
- * NOTE: This event is only emitted after you have called
- * startAppLevelAppearanceTrackingOS
+ * **NOTE:** This event is only emitted after you have called
+ * `startAppLevelAppearanceTrackingOS`
*/
on(event: 'appearance-changed', listener: (
/**
@@ -4774,49 +5840,83 @@ declare namespace Electron {
*/
invertedColorScheme: boolean) => void): this;
/**
- * Important: In order to properly leverage this API, you must set the
- * NSMicrophoneUsageDescription and NSCameraUsageDescription strings in your app's
- * Info.plist file. The values for these keys will be used to populate the
+ * A promise that resolves with `true` if consent was granted and `false` if it was
+ * denied. If an invalid `mediaType` is passed, the promise will be rejected. If an
+ * access request was denied and later is changed through the System Preferences
+ * pane, a restart of the app will be required for the new permissions to take
+ * effect. If access has already been requested and denied, it _must_ be changed
+ * through the preference pane; an alert will not pop up and the promise will
+ * resolve with the existing access status.
+ *
+ * **Important:** In order to properly leverage this API, you must set the
+ * `NSMicrophoneUsageDescription` and `NSCameraUsageDescription` strings in your
+ * app's `Info.plist` file. The values for these keys will be used to populate the
* permission dialogs so that the user will be properly informed as to the purpose
* of the permission request. See Electron Application Distribution for more
- * information about how to set these in the context of Electron. This user consent
- * was not required until macOS 10.14 Mojave, so this method will always return
- * true if your system is running 10.13 High Sierra or lower.
+ * information about how to set these in the context of Electron.
+ *
+ * This user consent was not required until macOS 10.14 Mojave, so this method will
+ * always return `true` if your system is running 10.13 High Sierra or lower.
*/
askForMediaAccess(mediaType: 'microphone' | 'camera'): Promise<boolean>;
/**
- * NOTE: This API will return false on macOS systems older than Sierra 10.12.2.
+ * whether or not this device has the ability to use Touch ID.
+ *
+ * **NOTE:** This API will return `false` on macOS systems older than Sierra
+ * 10.12.2.
*/
canPromptTouchID(): boolean;
/**
- * This API is only available on macOS 10.14 Mojave or newer.
+ * The users current system wide accent color preference in RGBA hexadecimal form.
+ *
+This API is only available on macOS 10.14 Mojave or newer.
*/
getAccentColor(): string;
/**
- * Returns an object with system animation settings.
+ * * `shouldRenderRichAnimation` Boolean - Returns true if rich animations should
+ * be rendered. Looks at session type (e.g. remote desktop) and accessibility
+ * settings to give guidance for heavy animations.
+ * * `scrollAnimationsEnabledBySystem` Boolean - Determines on a per-platform basis
+ * whether scroll animations (e.g. produced by home/end key) should be enabled.
+ * * `prefersReducedMotion` Boolean - Determines whether the user desires reduced
+ * motion based on platform APIs.
+ *
+Returns an object with system animation settings.
*/
getAnimationSettings(): AnimationSettings;
/**
+ * | `null` - Can be `dark`, `light` or `unknown`.
+ *
* Gets the macOS appearance setting that you have declared you want for your
* application, maps to NSApplication.appearance. You can use the
- * setAppLevelAppearance API to set this value.
+ * `setAppLevelAppearance` API to set this value.
*/
getAppLevelAppearance(): ('dark' | 'light' | 'unknown');
- getColor(color: '3d-dark-shadow' | '3d-dark-shadow' | '3d-face' | '3d-highlight' | '3d-light' | '3d-shadow' | 'active-border' | 'active-caption' | 'active-caption-gradient' | 'app-workspace' | 'button-text' | 'caption-text' | 'desktop' | 'disabled-text' | 'highlight' | 'highlight-text' | 'hotlight' | 'inactive-border' | 'inactive-caption' | 'inactive-caption-gradient' | 'inactive-caption-text' | 'info-background' | 'info-text' | 'menu' | 'menu-highlight' | 'menubar' | 'menu-text' | 'scrollbar' | 'window' | 'window-frame' | 'window-text' | 'alternate-selected-control-text' | 'alternate-selected-control-text' | 'control-background' | 'control' | 'control-text' | 'disabled-control-text' | 'find-highlight' | 'grid' | 'header-text' | 'highlight' | 'keyboard-focus-indicator' | 'label' | 'link' | 'placeholder-text' | 'quaternary-label' | 'scrubber-textured-background' | 'secondary-label' | 'selected-content-background' | 'selected-control' | 'selected-control-text' | 'selected-menu-item' | 'selected-text-background' | 'selected-text' | 'separator' | 'shadow' | 'tertiary-label' | 'text-background' | 'text' | 'under-page-background' | 'unemphasized-selected-content-background' | 'unemphasized-selected-text-background' | 'unemphasized-selected-text' | 'window-background' | 'window-frame-text'): string;
/**
+ * The system color setting in RGB hexadecimal form (`#ABCDEF`). See the Windows
+ * docs and the MacOS docs for more details.
+ */
+ getColor(color: '3d-dark-shadow' | '3d-face' | '3d-highlight' | '3d-light' | '3d-shadow' | 'active-border' | 'active-caption' | 'active-caption-gradient' | 'app-workspace' | 'button-text' | 'caption-text' | 'desktop' | 'disabled-text' | 'highlight' | 'highlight-text' | 'hotlight' | 'inactive-border' | 'inactive-caption' | 'inactive-caption-gradient' | 'inactive-caption-text' | 'info-background' | 'info-text' | 'menu' | 'menu-highlight' | 'menubar' | 'menu-text' | 'scrollbar' | 'window' | 'window-frame' | 'window-text' | 'alternate-selected-control-text' | 'control-background' | 'control' | 'control-text' | 'disabled-control-text' | 'find-highlight' | 'grid' | 'header-text' | 'highlight' | 'keyboard-focus-indicator' | 'label' | 'link' | 'placeholder-text' | 'quaternary-label' | 'scrubber-textured-background' | 'secondary-label' | 'selected-content-background' | 'selected-control' | 'selected-control-text' | 'selected-menu-item' | 'selected-text-background' | 'selected-text' | 'separator' | 'shadow' | 'tertiary-label' | 'text-background' | 'text' | 'under-page-background' | 'unemphasized-selected-content-background' | 'unemphasized-selected-text-background' | 'unemphasized-selected-text' | 'window-background' | 'window-frame-text'): string;
+ /**
+ * Can be `dark`, `light` or `unknown`.
+ *
* Gets the macOS appearance setting that is currently applied to your application,
- * maps to NSApplication.effectiveAppearance Please note that until Electron is
- * built targeting the 10.14 SDK, your application's effectiveAppearance will
- * default to 'light' and won't inherit the OS preference. In the interim in order
- * for your application to inherit the OS preference you must set the
- * NSRequiresAquaSystemAppearance key in your apps Info.plist to false. If you are
- * using electron-packager or electron-forge just set the enableDarwinDarkMode
- * packager option to true. See the Electron Packager API for more details.
+ * maps to NSApplication.effectiveAppearance
+ *
+ * Please note that until Electron is built targeting the 10.14 SDK, your
+ * application's `effectiveAppearance` will default to 'light' and won't inherit
+ * the OS preference. In the interim in order for your application to inherit the
+ * OS preference you must set the `NSRequiresAquaSystemAppearance` key in your apps
+ * `Info.plist` to `false`. If you are using `electron-packager` or
+ * `electron-forge` just set the `enableDarwinDarkMode` packager option to `true`.
+ * See the Electron Packager API for more details.
*/
getEffectiveAppearance(): ('dark' | 'light' | 'unknown');
/**
+ * Can be `not-determined`, `granted`, `denied`, `restricted` or `unknown`.
+ *
* This user consent was not required until macOS 10.14 Mojave, so this method will
- * always return granted if your system is running 10.13 High Sierra or lower.
+ * always return `granted` if your system is running 10.13 High Sierra or lower.
*/
getMediaAccessStatus(mediaType: string): ('not-determined' | 'granted' | 'denied' | 'restricted' | 'unknown');
/**
@@ -4826,95 +5926,148 @@ declare namespace Electron {
*/
getSystemColor(color: 'blue' | 'brown' | 'gray' | 'green' | 'orange' | 'pink' | 'purple' | 'red' | 'yellow'): void;
/**
- * Some popular key and types are:
+ * The value of `key` in `NSUserDefaults`.
+ *
+ * Some popular `key` and `type`s are:
+ *
+ * * `AppleInterfaceStyle`: `string`
+ * * `AppleAquaColorVariant`: `integer`
+ * * `AppleHighlightColor`: `string`
+ * * `AppleShowScrollBars`: `string`
+ * * `NSNavRecentPlaces`: `array`
+ * * `NSPreferredWebServices`: `dictionary`
+ * * `NSUserDictionaryReplacementItems`: `array`
*/
getUserDefault(key: string, type: 'string' | 'boolean' | 'integer' | 'float' | 'double' | 'url' | 'array' | 'dictionary'): any;
/**
+ * `true` if DWM composition (Aero Glass) is enabled, and `false` otherwise.
+ *
* An example of using it to determine if you should create a transparent window or
* not (transparent windows won't work correctly when DWM composition is disabled):
*/
isAeroGlassEnabled(): boolean;
+ /**
+ * Whether the system is in Dark Mode.
+ */
isDarkMode(): boolean;
+ /**
+ * `true` if a high contrast theme is active, `false` otherwise.
+ */
isHighContrastColorScheme(): boolean;
+ /**
+ * `true` if an inverted color scheme (a high contrast color scheme with light text
+ * and dark backgrounds) is active, `false` otherwise.
+ */
isInvertedColorScheme(): boolean;
+ /**
+ * Whether the Swipe between pages setting is on.
+ */
isSwipeTrackingFromScrollEventsEnabled(): boolean;
+ /**
+ * `true` if the current process is a trusted accessibility client and `false` if
+ * it is not.
+ */
isTrustedAccessibilityClient(prompt: boolean): boolean;
/**
- * Posts event as native notifications of macOS. The userInfo is an Object that
+ * Posts `event` as native notifications of macOS. The `userInfo` is an Object that
* contains the user information dictionary sent along with the notification.
*/
postLocalNotification(event: string, userInfo: any): void;
/**
- * Posts event as native notifications of macOS. The userInfo is an Object that
+ * Posts `event` as native notifications of macOS. The `userInfo` is an Object that
* contains the user information dictionary sent along with the notification.
*/
postNotification(event: string, userInfo: any, deliverImmediately?: boolean): void;
/**
- * Posts event as native notifications of macOS. The userInfo is an Object that
+ * Posts `event` as native notifications of macOS. The `userInfo` is an Object that
* contains the user information dictionary sent along with the notification.
*/
postWorkspaceNotification(event: string, userInfo: any): void;
/**
+ * resolves if the user has successfully authenticated with Touch ID.
+ *
* This API itself will not protect your user data; rather, it is a mechanism to
* allow you to do so. Native apps will need to set Access Control Constants like
- * kSecAccessControlUserPresence on the their keychain entry so that reading it
+ * `kSecAccessControlUserPresence` on the their keychain entry so that reading it
* would auto-prompt for Touch ID biometric consent. This could be done with
- * node-keytar, such that one would store an encryption key with node-keytar and
- * only fetch it if promptTouchID() resolves. NOTE: This API will return a rejected
- * Promise on macOS systems older than Sierra 10.12.2.
+ * `node-keytar`, such that one would store an encryption key with `node-keytar`
+ * and only fetch it if `promptTouchID()` resolves.
+ *
+ * **NOTE:** This API will return a rejected Promise on macOS systems older than
+ * Sierra 10.12.2.
*/
promptTouchID(reason: string): Promise<void>;
/**
- * Add the specified defaults to your application's NSUserDefaults.
+ * Add the specified defaults to your application's `NSUserDefaults`.
*/
registerDefaults(defaults: any): void;
/**
- * Removes the key in NSUserDefaults. This can be used to restore the default or
- * global value of a key previously set with setUserDefault.
+ * Removes the `key` in `NSUserDefaults`. This can be used to restore the default
+ * or global value of a `key` previously set with `setUserDefault`.
*/
removeUserDefault(key: string): void;
/**
* Sets the appearance setting for your application, this should override the
- * system default and override the value of getEffectiveAppearance.
+ * system default and override the value of `getEffectiveAppearance`.
*/
- setAppLevelAppearance(appearance: 'dark' | 'light'): void;
+ setAppLevelAppearance(appearance: (('dark' | 'light')) | (null)): void;
/**
- * Set the value of key in NSUserDefaults. Note that type should match actual type
- * of value. An exception is thrown if they don't. Some popular key and types are:
+ * Set the value of `key` in `NSUserDefaults`.
+ *
+ * Note that `type` should match actual type of `value`. An exception is thrown if
+ * they don't.
+ *
+Some popular `key` and `type`s are:
+
+* `ApplePressAndHoldEnabled`: `boolean`
*/
setUserDefault(key: string, type: string, value: string): void;
/**
- * Same as subscribeNotification, but uses NSNotificationCenter for local defaults.
- * This is necessary for events such as NSUserDefaultsDidChangeNotification.
+ * The ID of this subscription
+ *
+ * Same as `subscribeNotification`, but uses `NSNotificationCenter` for local
+ * defaults. This is necessary for events such as
+ * `NSUserDefaultsDidChangeNotification`.
*/
subscribeLocalNotification(event: string, callback: (event: string, userInfo: any) => void): number;
/**
- * Subscribes to native notifications of macOS, callback will be called with
- * callback(event, userInfo) when the corresponding event happens. The userInfo is
- * an Object that contains the user information dictionary sent along with the
- * notification. The id of the subscriber is returned, which can be used to
- * unsubscribe the event. Under the hood this API subscribes to
- * NSDistributedNotificationCenter, example values of event are:
+ * The ID of this subscription
+ *
+ * Subscribes to native notifications of macOS, `callback` will be called with
+ * `callback(event, userInfo)` when the corresponding `event` happens. The
+ * `userInfo` is an Object that contains the user information dictionary sent along
+ * with the notification.
+ *
+ * The `id` of the subscriber is returned, which can be used to unsubscribe the
+ * `event`.
+ *
+ * Under the hood this API subscribes to `NSDistributedNotificationCenter`, example
+ * values of `event` are:
+ *
+ * * `AppleInterfaceThemeChangedNotification`
+ * * `AppleAquaColorVariantChanged`
+ * * `AppleColorPreferencesChangedNotification`
+ * * `AppleShowScrollBarsSettingChanged`
*/
subscribeNotification(event: string, callback: (event: string, userInfo: any) => void): number;
/**
- * Same as subscribeNotification, but uses
- * NSWorkspace.sharedWorkspace.notificationCenter. This is necessary for events
- * such as NSWorkspaceDidActivateApplicationNotification.
+ * Same as `subscribeNotification`, but uses
+ * `NSWorkspace.sharedWorkspace.notificationCenter`. This is necessary for events
+ * such as `NSWorkspaceDidActivateApplicationNotification`.
*/
subscribeWorkspaceNotification(event: string, callback: (event: string, userInfo: any) => void): void;
/**
- * Same as unsubscribeNotification, but removes the subscriber from
- * NSNotificationCenter.
+ * Same as `unsubscribeNotification`, but removes the subscriber from
+ * `NSNotificationCenter`.
*/
unsubscribeLocalNotification(id: number): void;
/**
- * Removes the subscriber with id.
+ * Removes the subscriber with `id`.
*/
unsubscribeNotification(id: number): void;
/**
- * Same as unsubscribeNotification, but removes the subscriber from
- * NSWorkspace.sharedWorkspace.notificationCenter.
+ * Same as `unsubscribeNotification`, but removes the subscriber from
+ * `NSWorkspace.sharedWorkspace.notificationCenter`.
*/
unsubscribeWorkspaceNotification(id: number): void;
}
@@ -4924,7 +6077,7 @@ declare namespace Electron {
// Docs: http://electronjs.org/docs/api/structures/task
/**
- * The command line arguments when program is executed.
+ * The command line arguments when `program` is executed.
*/
arguments: string;
/**
@@ -4940,11 +6093,11 @@ declare namespace Electron {
/**
* The absolute path to an icon to be displayed in a JumpList, which can be an
* arbitrary resource file that contains an icon. You can usually specify
- * process.execPath to show the icon of the program.
+ * `process.execPath` to show the icon of the program.
*/
iconPath: string;
/**
- * Path of the program to execute, usually you should specify process.execPath
+ * Path of the program to execute, usually you should specify `process.execPath`
* which opens the current program.
*/
program: string;
@@ -4961,7 +6114,7 @@ declare namespace Electron {
click: Function;
/**
* Control specific states and behaviors of the button. By default, it is
- * ['enabled'].
+ * `['enabled']`.
*/
flags?: string[];
/**
@@ -4974,77 +6127,121 @@ declare namespace Electron {
tooltip?: string;
}
- class TouchBarButton extends EventEmitter {
+ class TouchBar extends NodeJS.EventEmitter {
+
+ // Docs: http://electronjs.org/docs/api/touch-bar
+
+ /**
+ * TouchBar
+ */
+ constructor(options: TouchBarConstructorOptions);
+ escapeItem: (TouchBarButton | TouchBarColorPicker | TouchBarGroup | TouchBarLabel | TouchBarPopover | TouchBarScrubber | TouchBarSegmentedControl | TouchBarSlider | TouchBarSpacer | null);
+ static TouchBarButton: typeof TouchBarButton;
+ static TouchBarColorPicker: typeof TouchBarColorPicker;
+ static TouchBarGroup: typeof TouchBarGroup;
+ static TouchBarLabel: typeof TouchBarLabel;
+ static TouchBarPopover: typeof TouchBarPopover;
+ static TouchBarScrubber: typeof TouchBarScrubber;
+ static TouchBarSegmentedControl: typeof TouchBarSegmentedControl;
+ static TouchBarSlider: typeof TouchBarSlider;
+ static TouchBarSpacer: typeof TouchBarSpacer;
+ }
+
+ class TouchBarButton extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/touch-bar-button
+ /**
+ * TouchBarButton
+ */
constructor(options: TouchBarButtonConstructorOptions);
backgroundColor: string;
icon: NativeImage;
label: string;
}
- class TouchBarColorPicker extends EventEmitter {
+ class TouchBarColorPicker extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/touch-bar-color-picker
+ /**
+ * TouchBarColorPicker
+ */
constructor(options: TouchBarColorPickerConstructorOptions);
availableColors: string[];
selectedColor: string;
}
- class TouchBarGroup extends EventEmitter {
+ class TouchBarGroup extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/touch-bar-group
+ /**
+ * TouchBarGroup
+ */
constructor(options: TouchBarGroupConstructorOptions);
}
- class TouchBarLabel extends EventEmitter {
+ class TouchBarLabel extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/touch-bar-label
+ /**
+ * TouchBarLabel
+ */
constructor(options: TouchBarLabelConstructorOptions);
label: string;
textColor: string;
}
- class TouchBarPopover extends EventEmitter {
+ class TouchBarPopover extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/touch-bar-popover
+ /**
+ * TouchBarPopover
+ */
constructor(options: TouchBarPopoverConstructorOptions);
icon: NativeImage;
label: string;
}
- class TouchBarScrubber extends EventEmitter {
+ class TouchBarScrubber extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/touch-bar-scrubber
+ /**
+ * TouchBarScrubber
+ */
constructor(options: TouchBarScrubberConstructorOptions);
continuous: boolean;
items: ScrubberItem[];
- mode: string;
- overlayStyle: string;
- selectedStyle: string;
+ mode: ('fixed' | 'free');
+ overlayStyle: ('background' | 'outline' | 'null');
+ selectedStyle: ('background' | 'outline' | 'null');
showArrowButtons: boolean;
}
- class TouchBarSegmentedControl extends EventEmitter {
+ class TouchBarSegmentedControl extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/touch-bar-segmented-control
+ /**
+ * TouchBarSegmentedControl
+ */
constructor(options: TouchBarSegmentedControlConstructorOptions);
segments: SegmentedControlSegment[];
segmentStyle: string;
selectedIndex: number;
}
- class TouchBarSlider extends EventEmitter {
+ class TouchBarSlider extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/touch-bar-slider
+ /**
+ * TouchBarSlider
+ */
constructor(options: TouchBarSliderConstructorOptions);
label: string;
maxValue: number;
@@ -5052,53 +6249,32 @@ declare namespace Electron {
value: number;
}
- class TouchBarSpacer extends EventEmitter {
+ class TouchBarSpacer extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/touch-bar-spacer
+ /**
+ * TouchBarSpacer
+ */
constructor(options: TouchBarSpacerConstructorOptions);
}
- class TouchBar extends EventEmitter {
-
- // Docs: http://electronjs.org/docs/api/touch-bar
-
- constructor(options: TouchBarConstructorOptions);
- escapeItem: (TouchBarButton | TouchBarColorPicker | TouchBarGroup | TouchBarLabel | TouchBarPopover | TouchBarScrubber | TouchBarSegmentedControl | TouchBarSlider | TouchBarSpacer | null);
- static TouchBarButton: typeof TouchBarButton;
- static TouchBarColorPicker: typeof TouchBarColorPicker;
- static TouchBarGroup: typeof TouchBarGroup;
- static TouchBarLabel: typeof TouchBarLabel;
- static TouchBarPopover: typeof TouchBarPopover;
- static TouchBarScrubber: typeof TouchBarScrubber;
- static TouchBarSegmentedControl: typeof TouchBarSegmentedControl;
- static TouchBarSlider: typeof TouchBarSlider;
- static TouchBarSpacer: typeof TouchBarSpacer;
- }
-
interface TraceCategoriesAndOptions {
// Docs: http://electronjs.org/docs/api/structures/trace-categories-and-options
- /**
- * – is a filter to control what category groups should be traced. A filter can
- * have an optional prefix to exclude category groups that contain a matching
- * category. Having both included and excluded category patterns in the same list
- * is not supported. Examples: test_MyTest*, test_MyTest*,test_OtherStuff,
- * -excluded_category1,-excluded_category2.
- */
categoryFilter: string;
/**
* Controls what kind of tracing is enabled, it is a comma-delimited sequence of
- * the following strings: record-until-full, record-continuously, trace-to-console,
- * enable-sampling, enable-systrace, e.g. 'record-until-full,enable-sampling'. The
- * first 3 options are trace recording modes and hence mutually exclusive. If more
- * than one trace recording modes appear in the traceOptions string, the last one
- * takes precedence. If none of the trace recording modes are specified, recording
- * mode is record-until-full. The trace option will first be reset to the default
- * option (record_mode set to record-until-full, enable_sampling and
- * enable_systrace set to false) before options parsed from traceOptions are
- * applied on it.
+ * the following strings: `record-until-full`, `record-continuously`,
+ * `trace-to-console`, `enable-sampling`, `enable-systrace`, e.g.
+ * `'record-until-full,enable-sampling'`. The first 3 options are trace recording
+ * modes and hence mutually exclusive. If more than one trace recording modes
+ * appear in the `traceOptions` string, the last one takes precedence. If none of
+ * the trace recording modes are specified, recording mode is `record-until-full`.
+ * The trace option will first be reset to the default option (`record_mode` set to
+ * `record-until-full`, `enable_sampling` and `enable_systrace` set to `false`)
+ * before options parsed from `traceOptions` are applied on it.
*/
traceOptions: string;
}
@@ -5138,13 +6314,13 @@ declare namespace Electron {
*/
transactionIdentifier: string;
/**
- * The transaction state, can be purchasing, purchased, failed, restored or
- * deferred.
+ * The transaction state, can be `purchasing`, `purchased`, `failed`, `restored` or
+ * `deferred`.
*/
transactionState: ('purchasing' | 'purchased' | 'failed' | 'restored' | 'deferred');
}
- class Tray extends EventEmitter {
+ class Tray extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/tray
@@ -5398,6 +6574,9 @@ declare namespace Electron {
* The bounds of tray icon.
*/
bounds: Rectangle) => void): this;
+ /**
+ * Tray
+ */
constructor(image: (NativeImage) | (string));
/**
* Destroys the tray icon immediately.
@@ -5408,16 +6587,28 @@ declare namespace Electron {
*/
displayBalloon(options: DisplayBalloonOptions): void;
/**
- * The bounds of this tray icon as Object.
+ * The `bounds` of this tray icon as `Object`.
*/
getBounds(): Rectangle;
+ /**
+ * Whether double click events will be ignored.
+ */
getIgnoreDoubleClickEvents(): boolean;
- getTitle(title: string): string;
+ /**
+ * * `title` String
+
+the title displayed next to the tray icon in the status bar
+ */
+ getTitle(): ('title');
+ /**
+ * Whether the tray icon is destroyed.
+ */
isDestroyed(): boolean;
/**
- * Pops up the context menu of the tray icon. When menu is passed, the menu will be
- * shown instead of the tray icon's context menu. The position is only available on
- * Windows, and it is (0, 0) by default.
+ * Pops up the context menu of the tray icon. When `menu` is passed, the `menu`
+ * will be shown instead of the tray icon's context menu.
+ *
+The `position` is only available on Windows, and it is (0, 0) by default.
*/
popUpContextMenu(menu?: Menu, position?: Point): void;
/**
@@ -5425,23 +6616,25 @@ declare namespace Electron {
*/
setContextMenu(menu: (Menu) | (null)): void;
/**
- * Sets when the tray's icon background becomes highlighted (in blue). Note: You
- * can use highlightMode with a BrowserWindow by toggling between 'never' and
- * 'always' modes when the window visibility changes.
+ * Sets when the tray's icon background becomes highlighted (in blue).
+ *
+ * **Note:** You can use `highlightMode` with a `BrowserWindow` by toggling between
+ * `'never'` and `'always'` modes when the window visibility changes.
*/
setHighlightMode(mode: 'selection' | 'always' | 'never'): void;
/**
* Sets the option to ignore double click events. Ignoring these events allows you
- * to detect every individual click of the tray icon. This value is set to false by
- * default.
+ * to detect every individual click of the tray icon.
+ *
+This value is set to false by default.
*/
setIgnoreDoubleClickEvents(ignore: boolean): void;
/**
- * Sets the image associated with this tray icon.
+ * Sets the `image` associated with this tray icon.
*/
setImage(image: (NativeImage) | (string)): void;
/**
- * Sets the image associated with this tray icon when pressed on macOS.
+ * Sets the `image` associated with this tray icon when pressed on macOS.
*/
setPressedImage(image: (NativeImage) | (string)): void;
/**
@@ -5464,7 +6657,7 @@ declare namespace Electron {
*/
blobUUID: string;
/**
- * blob.
+ * `blob`.
*/
type: string;
}
@@ -5497,7 +6690,7 @@ declare namespace Electron {
*/
filePath: string;
/**
- * Number of bytes to read from offset. Defaults to 0.
+ * Number of bytes to read from `offset`. Defaults to `0`.
*/
length: number;
/**
@@ -5505,11 +6698,11 @@ declare namespace Electron {
*/
modificationTime: number;
/**
- * Defaults to 0.
+ * Defaults to `0`.
*/
offset: number;
/**
- * file.
+ * `file`.
*/
type: string;
}
@@ -5523,22 +6716,34 @@ declare namespace Electron {
*/
bytes: Buffer;
/**
- * rawData.
+ * `rawData`.
*/
type: string;
}
- class WebContents extends EventEmitter {
+ class WebContents extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/web-contents
+ /**
+ * A WebContents instance with the given ID.
+ */
static fromId(id: number): WebContents;
+ /**
+ * An array of all `WebContents` instances. This will contain web contents for all
+ * windows, webviews, opened devtools, and devtools extension background pages.
+ */
static getAllWebContents(): WebContents[];
+ /**
+ * The web contents that is focused in this application, otherwise returns `null`.
+ */
static getFocusedWebContents(): WebContents;
/**
- * Emitted before dispatching the keydown and keyup events in the page. Calling
- * event.preventDefault will prevent the page keydown/keyup events and the menu
- * shortcuts. To only prevent the menu shortcuts, use setIgnoreMenuShortcuts:
+ * Emitted before dispatching the `keydown` and `keyup` events in the page. Calling
+ * `event.preventDefault` will prevent the page `keydown`/`keyup` events and the
+ * menu shortcuts.
+ *
+To only prevent the menu shortcuts, use `setIgnoreMenuShortcuts`:
*/
on(event: 'before-input-event', listener: (event: Event,
/**
@@ -5561,8 +6766,9 @@ declare namespace Electron {
*/
input: Input) => void): this;
/**
- * Emitted when failed to verify the certificate for url. The usage is the same
- * with the certificate-error event of app.
+ * Emitted when failed to verify the `certificate` for `url`.
+ *
+The usage is the same with the `certificate-error` event of `app`.
*/
on(event: 'certificate-error', listener: (event: Event,
url: string,
@@ -5598,7 +6804,7 @@ declare namespace Electron {
callback: (isTrusted: boolean) => void) => void): this;
/**
* Emitted when the associated window logs a console message. Will not be emitted
- * for windows with offscreen rendering enabled.
+ * for windows with *offscreen rendering* enabled.
*/
on(event: 'console-message', listener: (event: Event,
level: number,
@@ -5643,87 +6849,89 @@ declare namespace Electron {
removeListener(event: 'crashed', listener: (event: Event,
killed: boolean) => void): this;
/**
- * Emitted when the cursor's type changes. The type parameter can be default,
- * crosshair, pointer, text, wait, help, e-resize, n-resize, ne-resize, nw-resize,
- * s-resize, se-resize, sw-resize, w-resize, ns-resize, ew-resize, nesw-resize,
- * nwse-resize, col-resize, row-resize, m-panning, e-panning, n-panning,
- * ne-panning, nw-panning, s-panning, se-panning, sw-panning, w-panning, move,
- * vertical-text, cell, context-menu, alias, progress, nodrop, copy, none,
- * not-allowed, zoom-in, zoom-out, grab, grabbing or custom. If the type parameter
- * is custom, the image parameter will hold the custom cursor image in a
- * NativeImage, and scale, size and hotspot will hold additional information about
- * the custom cursor.
+ * Emitted when the cursor's type changes. The `type` parameter can be `default`,
+ * `crosshair`, `pointer`, `text`, `wait`, `help`, `e-resize`, `n-resize`,
+ * `ne-resize`, `nw-resize`, `s-resize`, `se-resize`, `sw-resize`, `w-resize`,
+ * `ns-resize`, `ew-resize`, `nesw-resize`, `nwse-resize`, `col-resize`,
+ * `row-resize`, `m-panning`, `e-panning`, `n-panning`, `ne-panning`, `nw-panning`,
+ * `s-panning`, `se-panning`, `sw-panning`, `w-panning`, `move`, `vertical-text`,
+ * `cell`, `context-menu`, `alias`, `progress`, `nodrop`, `copy`, `none`,
+ * `not-allowed`, `zoom-in`, `zoom-out`, `grab`, `grabbing` or `custom`.
+ *
+ * If the `type` parameter is `custom`, the `image` parameter will hold the custom
+ * cursor image in a `NativeImage`, and `scale`, `size` and `hotspot` will hold
+ * additional information about the custom cursor.
*/
on(event: 'cursor-changed', listener: (event: Event,
type: string,
- image?: NativeImage,
+ image: NativeImage,
/**
* scaling factor for the custom cursor.
*/
- scale?: number,
+ scale: number,
/**
* the size of the `image`.
*/
- size?: Size,
+ size: Size,
/**
* coordinates of the custom cursor's hotspot.
*/
- hotspot?: Point) => void): this;
+ hotspot: Point) => void): this;
once(event: 'cursor-changed', listener: (event: Event,
type: string,
- image?: NativeImage,
+ image: NativeImage,
/**
* scaling factor for the custom cursor.
*/
- scale?: number,
+ scale: number,
/**
* the size of the `image`.
*/
- size?: Size,
+ size: Size,
/**
* coordinates of the custom cursor's hotspot.
*/
- hotspot?: Point) => void): this;
+ hotspot: Point) => void): this;
addListener(event: 'cursor-changed', listener: (event: Event,
type: string,
- image?: NativeImage,
+ image: NativeImage,
/**
* scaling factor for the custom cursor.
*/
- scale?: number,
+ scale: number,
/**
* the size of the `image`.
*/
- size?: Size,
+ size: Size,
/**
* coordinates of the custom cursor's hotspot.
*/
- hotspot?: Point) => void): this;
+ hotspot: Point) => void): this;
removeListener(event: 'cursor-changed', listener: (event: Event,
type: string,
- image?: NativeImage,
+ image: NativeImage,
/**
* scaling factor for the custom cursor.
*/
- scale?: number,
+ scale: number,
/**
* the size of the `image`.
*/
- size?: Size,
+ size: Size,
/**
* coordinates of the custom cursor's hotspot.
*/
- hotspot?: Point) => void): this;
+ hotspot: Point) => void): this;
/**
- * Emitted when desktopCapturer.getSources() is called in the renderer process.
- * Calling event.preventDefault() will make it return empty sources.
+ * Emitted when `desktopCapturer.getSources()` is called in the renderer process.
+ * Calling `event.preventDefault()` will make it return empty sources.
*/
on(event: 'desktop-capturer-get-sources', listener: (event: Event) => void): this;
once(event: 'desktop-capturer-get-sources', listener: (event: Event) => void): this;
addListener(event: 'desktop-capturer-get-sources', listener: (event: Event) => void): this;
removeListener(event: 'desktop-capturer-get-sources', listener: (event: Event) => void): this;
/**
- * Emitted when webContents is destroyed.
+ * Emitted when `webContents` is destroyed.
*/
on(event: 'destroyed', listener: Function): this;
once(event: 'destroyed', listener: Function): this;
@@ -5758,26 +6966,26 @@ declare namespace Electron {
addListener(event: 'devtools-reload-page', listener: Function): this;
removeListener(event: 'devtools-reload-page', listener: Function): this;
/**
- * Emitted when a <webview> has been attached to this web contents.
+ * Emitted when a `<webview>` has been attached to this web contents.
*/
on(event: 'did-attach-webview', listener: (event: Event,
/**
- * The guest web contents that is used by the `
+ * The guest web contents that is used by the `<webview>`.
*/
webContents: WebContents) => void): this;
once(event: 'did-attach-webview', listener: (event: Event,
/**
- * The guest web contents that is used by the `
+ * The guest web contents that is used by the `<webview>`.
*/
webContents: WebContents) => void): this;
addListener(event: 'did-attach-webview', listener: (event: Event,
/**
- * The guest web contents that is used by the `
+ * The guest web contents that is used by the `<webview>`.
*/
webContents: WebContents) => void): this;
removeListener(event: 'did-attach-webview', listener: (event: Event,
/**
- * The guest web contents that is used by the `
+ * The guest web contents that is used by the `<webview>`.
*/
webContents: WebContents) => void): this;
/**
@@ -5805,9 +7013,9 @@ declare namespace Electron {
*/
color: (string) | (null)) => void): this;
/**
- * This event is like did-finish-load but emitted when the load failed or was
- * cancelled, e.g. window.stop() is invoked. The full list of error codes and their
- * meaning is available here.
+ * This event is like `did-finish-load` but emitted when the load failed or was
+ * cancelled, e.g. `window.stop()` is invoked. The full list of error codes and
+ * their meaning is available here.
*/
on(event: 'did-fail-load', listener: (event: Event,
errorCode: number,
@@ -5839,7 +7047,7 @@ declare namespace Electron {
frameRoutingId: number) => void): this;
/**
* Emitted when the navigation is done, i.e. the spinner of the tab has stopped
- * spinning, and the onload event was dispatched.
+ * spinning, and the `onload` event was dispatched.
*/
on(event: 'did-finish-load', listener: Function): this;
once(event: 'did-finish-load', listener: Function): this;
@@ -5865,9 +7073,11 @@ declare namespace Electron {
frameProcessId: number,
frameRoutingId: number) => void): this;
/**
- * Emitted when any frame navigation is done. This event is not emitted for in-page
- * navigations, such as clicking anchor links or updating the window.location.hash.
- * Use did-navigate-in-page event for this purpose.
+ * Emitted when any frame navigation is done.
+ *
+ * This event is not emitted for in-page navigations, such as clicking anchor links
+ * or updating the `window.location.hash`. Use `did-navigate-in-page` event for
+ * this purpose.
*/
on(event: 'did-frame-navigate', listener: (event: Event,
url: string,
@@ -5922,9 +7132,11 @@ declare namespace Electron {
frameProcessId: number,
frameRoutingId: number) => void): this;
/**
- * Emitted when a main frame navigation is done. This event is not emitted for
- * in-page navigations, such as clicking anchor links or updating the
- * window.location.hash. Use did-navigate-in-page event for this purpose.
+ * Emitted when a main frame navigation is done.
+ *
+ * This event is not emitted for in-page navigations, such as clicking anchor links
+ * or updating the `window.location.hash`. Use `did-navigate-in-page` event for
+ * this purpose.
*/
on(event: 'did-navigate', listener: (event: Event,
url: string,
@@ -5967,10 +7179,11 @@ declare namespace Electron {
*/
httpStatusText: string) => void): this;
/**
- * Emitted when an in-page navigation happened in any frame. When in-page
- * navigation happens, the page URL changes but does not cause navigation outside
- * of the page. Examples of this occurring are when anchor links are clicked or
- * when the DOM hashchange event is triggered.
+ * Emitted when an in-page navigation happened in any frame.
+ *
+ * When in-page navigation happens, the page URL changes but does not cause
+ * navigation outside of the page. Examples of this occurring are when anchor links
+ * are clicked or when the DOM `hashchange` event is triggered.
*/
on(event: 'did-navigate-in-page', listener: (event: Event,
url: string,
@@ -5994,8 +7207,10 @@ declare namespace Electron {
frameRoutingId: number) => void): this;
/**
* Emitted after a server side redirect occurs during navigation. For example a
- * 302 redirect. This event can not be prevented, if you want to prevent redirects
- * you should checkout out the will-redirect event above.
+ * 302 redirect.
+ *
+ * This event can not be prevented, if you want to prevent redirects you should
+ * checkout out the `will-redirect` event above.
*/
on(event: 'did-redirect-navigation', listener: (event: Event,
url: string,
@@ -6029,8 +7244,8 @@ declare namespace Electron {
addListener(event: 'did-start-loading', listener: Function): this;
removeListener(event: 'did-start-loading', listener: Function): this;
/**
- * Emitted when any frame (including main) starts navigating. isInplace will be
- * true for in-page navigations.
+ * Emitted when any frame (including main) starts navigating. `isInplace` will be
+ * `true` for in-page navigations.
*/
on(event: 'did-start-navigation', listener: (event: Event,
url: string,
@@ -6078,7 +7293,7 @@ declare namespace Electron {
addListener(event: 'enter-html-full-screen', listener: Function): this;
removeListener(event: 'enter-html-full-screen', listener: Function): this;
/**
- * Emitted when a result is available for [webContents.findInPage] request.
+ * Emitted when a result is available for [`webContents.findInPage`] request.
*/
on(event: 'found-in-page', listener: (event: Event,
result: Result) => void): this;
@@ -6090,7 +7305,7 @@ declare namespace Electron {
result: Result) => void): this;
/**
* Emitted when the renderer process sends an asynchronous message via
- * ipcRenderer.send().
+ * `ipcRenderer.send()`.
*/
on(event: 'ipc-message', listener: (event: Event,
channel: string,
@@ -6106,7 +7321,7 @@ declare namespace Electron {
...args: any[]) => void): this;
/**
* Emitted when the renderer process sends a synchronous message via
- * ipcRenderer.sendSync().
+ * `ipcRenderer.sendSync()`.
*/
on(event: 'ipc-message-sync', listener: (event: Event,
channel: string,
@@ -6128,8 +7343,9 @@ declare namespace Electron {
addListener(event: 'leave-html-full-screen', listener: Function): this;
removeListener(event: 'leave-html-full-screen', listener: Function): this;
/**
- * Emitted when webContents wants to do basic auth. The usage is the same with the
- * login event of app.
+ * Emitted when `webContents` wants to do basic auth.
+ *
+The usage is the same with the `login` event of `app`.
*/
on(event: 'login', listener: (event: Event,
request: Request,
@@ -6162,14 +7378,16 @@ declare namespace Electron {
addListener(event: 'media-started-playing', listener: Function): this;
removeListener(event: 'media-started-playing', listener: Function): this;
/**
- * Emitted when the page requests to open a new window for a url. It could be
- * requested by window.open or an external link like <a target='_blank'>. By
- * default a new BrowserWindow will be created for the url. Calling
- * event.preventDefault() will prevent Electron from automatically creating a new
- * BrowserWindow. If you call event.preventDefault() and manually create a new
- * BrowserWindow then you must set event.newGuest to reference the new
- * BrowserWindow instance, failing to do so may result in unexpected behavior. For
- * example:
+ * Emitted when the page requests to open a new window for a `url`. It could be
+ * requested by `window.open` or an external link like `<a target='_blank'>`.
+ *
+ * By default a new `BrowserWindow` will be created for the `url`.
+ *
+ * Calling `event.preventDefault()` will prevent Electron from automatically
+ * creating a new `BrowserWindow`. If you call `event.preventDefault()` and
+ * manually create a new `BrowserWindow` then you must set `event.newGuest` to
+ * reference the new `BrowserWindow` instance, failing to do so may result in
+ * unexpected behavior. For example:
*/
on(event: 'new-window', listener: (event: Event,
url: string,
@@ -6180,7 +7398,7 @@ declare namespace Electron {
*/
disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other'),
/**
- * The options which will be used for creating the new .
+ * The options which will be used for creating the new `BrowserWindow`.
*/
options: any,
/**
@@ -6202,7 +7420,7 @@ declare namespace Electron {
*/
disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other'),
/**
- * The options which will be used for creating the new .
+ * The options which will be used for creating the new `BrowserWindow`.
*/
options: any,
/**
@@ -6224,7 +7442,7 @@ declare namespace Electron {
*/
disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other'),
/**
- * The options which will be used for creating the new .
+ * The options which will be used for creating the new `BrowserWindow`.
*/
options: any,
/**
@@ -6246,7 +7464,7 @@ declare namespace Electron {
*/
disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other'),
/**
- * The options which will be used for creating the new .
+ * The options which will be used for creating the new `BrowserWindow`.
*/
options: any,
/**
@@ -6326,7 +7544,8 @@ declare namespace Electron {
name: string,
version: string) => void): this;
/**
- * Emitted when the preload script preloadPath throws an unhandled exception error.
+ * Emitted when the preload script `preloadPath` throws an unhandled exception
+ * `error`.
*/
on(event: 'preload-error', listener: (event: Event,
preloadPath: string,
@@ -6341,9 +7560,9 @@ declare namespace Electron {
preloadPath: string,
error: Error) => void): this;
/**
- * Emitted when remote.getBuiltin() is called in the renderer process. Calling
- * event.preventDefault() will prevent the module from being returned. Custom value
- * can be returned by setting event.returnValue.
+ * Emitted when `remote.getBuiltin()` is called in the renderer process. Calling
+ * `event.preventDefault()` will prevent the module from being returned. Custom
+ * value can be returned by setting `event.returnValue`.
*/
on(event: 'remote-get-builtin', listener: (event: Event,
moduleName: string) => void): this;
@@ -6354,27 +7573,27 @@ declare namespace Electron {
removeListener(event: 'remote-get-builtin', listener: (event: Event,
moduleName: string) => void): this;
/**
- * Emitted when remote.getCurrentWebContents() is called in the renderer process.
- * Calling event.preventDefault() will prevent the object from being returned.
- * Custom value can be returned by setting event.returnValue.
+ * Emitted when `remote.getCurrentWebContents()` is called in the renderer process.
+ * Calling `event.preventDefault()` will prevent the object from being returned.
+ * Custom value can be returned by setting `event.returnValue`.
*/
on(event: 'remote-get-current-web-contents', listener: (event: Event) => void): this;
once(event: 'remote-get-current-web-contents', listener: (event: Event) => void): this;
addListener(event: 'remote-get-current-web-contents', listener: (event: Event) => void): this;
removeListener(event: 'remote-get-current-web-contents', listener: (event: Event) => void): this;
/**
- * Emitted when remote.getCurrentWindow() is called in the renderer process.
- * Calling event.preventDefault() will prevent the object from being returned.
- * Custom value can be returned by setting event.returnValue.
+ * Emitted when `remote.getCurrentWindow()` is called in the renderer process.
+ * Calling `event.preventDefault()` will prevent the object from being returned.
+ * Custom value can be returned by setting `event.returnValue`.
*/
on(event: 'remote-get-current-window', listener: (event: Event) => void): this;
once(event: 'remote-get-current-window', listener: (event: Event) => void): this;
addListener(event: 'remote-get-current-window', listener: (event: Event) => void): this;
removeListener(event: 'remote-get-current-window', listener: (event: Event) => void): this;
/**
- * Emitted when remote.getGlobal() is called in the renderer process. Calling
- * event.preventDefault() will prevent the global from being returned. Custom value
- * can be returned by setting event.returnValue.
+ * Emitted when `remote.getGlobal()` is called in the renderer process. Calling
+ * `event.preventDefault()` will prevent the global from being returned. Custom
+ * value can be returned by setting `event.returnValue`.
*/
on(event: 'remote-get-global', listener: (event: Event,
globalName: string) => void): this;
@@ -6385,9 +7604,9 @@ declare namespace Electron {
removeListener(event: 'remote-get-global', listener: (event: Event,
globalName: string) => void): this;
/**
- * Emitted when <webview>.getWebContents() is called in the renderer process.
- * Calling event.preventDefault() will prevent the object from being returned.
- * Custom value can be returned by setting event.returnValue.
+ * Emitted when `<webview>.getWebContents()` is called in the renderer process.
+ * Calling `event.preventDefault()` will prevent the object from being returned.
+ * Custom value can be returned by setting `event.returnValue`.
*/
on(event: 'remote-get-guest-web-contents', listener: (event: Event,
guestWebContents: WebContents) => void): this;
@@ -6398,9 +7617,9 @@ declare namespace Electron {
removeListener(event: 'remote-get-guest-web-contents', listener: (event: Event,
guestWebContents: WebContents) => void): this;
/**
- * Emitted when remote.require() is called in the renderer process. Calling
- * event.preventDefault() will prevent the module from being returned. Custom value
- * can be returned by setting event.returnValue.
+ * Emitted when `remote.require()` is called in the renderer process. Calling
+ * `event.preventDefault()` will prevent the module from being returned. Custom
+ * value can be returned by setting `event.returnValue`.
*/
on(event: 'remote-require', listener: (event: Event,
moduleName: string) => void): this;
@@ -6419,10 +7638,10 @@ declare namespace Electron {
removeListener(event: 'responsive', listener: Function): this;
/**
* Emitted when bluetooth device needs to be selected on call to
- * navigator.bluetooth.requestDevice. To use navigator.bluetooth api webBluetooth
- * should be enabled. If event.preventDefault is not called, first available device
- * will be selected. callback should be called with deviceId to be selected,
- * passing empty string to callback will cancel the request.
+ * `navigator.bluetooth.requestDevice`. To use `navigator.bluetooth` api
+ * `webBluetooth` should be enabled. If `event.preventDefault` is not called, first
+ * available device will be selected. `callback` should be called with `deviceId`
+ * to be selected, passing empty string to `callback` will cancel the request.
*/
on(event: 'select-bluetooth-device', listener: (event: Event,
devices: BluetoothDevice[],
@@ -6437,8 +7656,9 @@ declare namespace Electron {
devices: BluetoothDevice[],
callback: (deviceId: string) => void) => void): this;
/**
- * Emitted when a client certificate is requested. The usage is the same with the
- * select-client-certificate event of app.
+ * Emitted when a client certificate is requested.
+ *
+The usage is the same with the `select-client-certificate` event of `app`.
*/
on(event: 'select-client-certificate', listener: (event: Event,
url: string,
@@ -6475,12 +7695,15 @@ declare namespace Electron {
removeListener(event: 'update-target-url', listener: (event: Event,
url: string) => void): this;
/**
- * Emitted when a <webview>'s web contents is being attached to this web contents.
- * Calling event.preventDefault() will destroy the guest page. This event can be
- * used to configure webPreferences for the webContents of a <webview> before it's
- * loaded, and provides the ability to set settings that can't be set via <webview>
- * attributes. Note: The specified preload script option will be appear as
- * preloadURL (not preload) in the webPreferences object emitted with this event.
+ * Emitted when a `<webview>`'s web contents is being attached to this web
+ * contents. Calling `event.preventDefault()` will destroy the guest page.
+ *
+ * This event can be used to configure `webPreferences` for the `webContents` of a
+ * `<webview>` before it's loaded, and provides the ability to set settings that
+ * can't be set via `<webview>` attributes.
+ *
+ * **Note:** The specified `preload` script option will be appear as `preloadURL`
+ * (not `preload`) in the `webPreferences` object emitted with this event.
*/
on(event: 'will-attach-webview', listener: (event: Event,
/**
@@ -6489,7 +7712,8 @@ declare namespace Electron {
*/
webPreferences: any,
/**
- * The other `
+ * The other `<webview>` parameters such as the `src` URL. This object can be
+ * modified to adjust the parameters of the guest page.
*/
params: any) => void): this;
once(event: 'will-attach-webview', listener: (event: Event,
@@ -6499,7 +7723,8 @@ declare namespace Electron {
*/
webPreferences: any,
/**
- * The other `
+ * The other `<webview>` parameters such as the `src` URL. This object can be
+ * modified to adjust the parameters of the guest page.
*/
params: any) => void): this;
addListener(event: 'will-attach-webview', listener: (event: Event,
@@ -6509,7 +7734,8 @@ declare namespace Electron {
*/
webPreferences: any,
/**
- * The other `
+ * The other `<webview>` parameters such as the `src` URL. This object can be
+ * modified to adjust the parameters of the guest page.
*/
params: any) => void): this;
removeListener(event: 'will-attach-webview', listener: (event: Event,
@@ -6519,17 +7745,22 @@ declare namespace Electron {
*/
webPreferences: any,
/**
- * The other `
+ * The other `<webview>` parameters such as the `src` URL. This object can be
+ * modified to adjust the parameters of the guest page.
*/
params: any) => void): this;
/**
* Emitted when a user or the page wants to start navigation. It can happen when
- * the window.location object is changed or a user clicks a link in the page. This
- * event will not emit when the navigation is started programmatically with APIs
- * like webContents.loadURL and webContents.back. It is also not emitted for
- * in-page navigations, such as clicking anchor links or updating the
- * window.location.hash. Use did-navigate-in-page event for this purpose. Calling
- * event.preventDefault() will prevent the navigation.
+ * the `window.location` object is changed or a user clicks a link in the page.
+ *
+ * This event will not emit when the navigation is started programmatically with
+ * APIs like `webContents.loadURL` and `webContents.back`.
+ *
+ * It is also not emitted for in-page navigations, such as clicking anchor links or
+ * updating the `window.location.hash`. Use `did-navigate-in-page` event for this
+ * purpose.
+
+Calling `event.preventDefault()` will prevent the navigation.
*/
on(event: 'will-navigate', listener: (event: Event,
url: string) => void): this;
@@ -6540,9 +7771,11 @@ declare namespace Electron {
removeListener(event: 'will-navigate', listener: (event: Event,
url: string) => void): this;
/**
- * Emitted when a beforeunload event handler is attempting to cancel a page unload.
- * Calling event.preventDefault() will ignore the beforeunload event handler and
- * allow the page to be unloaded.
+ * Emitted when a `beforeunload` event handler is attempting to cancel a page
+ * unload.
+ *
+ * Calling `event.preventDefault()` will ignore the `beforeunload` event handler
+ * and allow the page to be unloaded.
*/
on(event: 'will-prevent-unload', listener: (event: Event) => void): this;
once(event: 'will-prevent-unload', listener: (event: Event) => void): this;
@@ -6550,9 +7783,13 @@ declare namespace Electron {
removeListener(event: 'will-prevent-unload', listener: (event: Event) => void): this;
/**
* Emitted as a server side redirect occurs during navigation. For example a 302
- * redirect. This event will be emitted after did-start-navigation and always
- * before the did-redirect-navigation event for the same navigation. Calling
- * event.preventDefault() will prevent the navigation (not just the redirect).
+ * redirect.
+ *
+ * This event will be emitted after `did-start-navigation` and always before the
+ * `did-redirect-navigation` event for the same navigation.
+ *
+ * Calling `event.preventDefault()` will prevent the navigation (not just the
+ * redirect).
*/
on(event: 'will-redirect', listener: (event: Event,
url: string,
@@ -6584,28 +7821,45 @@ declare namespace Electron {
*/
addWorkSpace(path: string): void;
/**
- * Begin subscribing for presentation events and captured frames, the callback will
- * be called with callback(image, dirtyRect) when there is a presentation event.
- * The image is an instance of NativeImage that stores the captured frame. The
- * dirtyRect is an object with x, y, width, height properties that describes which
- * part of the page was repainted. If onlyDirty is set to true, image will only
- * contain the repainted area. onlyDirty defaults to false.
+ * Begin subscribing for presentation events and captured frames, the `callback`
+ * will be called with `callback(image, dirtyRect)` when there is a presentation
+ * event.
+ *
+ * The `image` is an instance of NativeImage that stores the captured frame.
+ *
+ * The `dirtyRect` is an object with `x, y, width, height` properties that
+ * describes which part of the page was repainted. If `onlyDirty` is set to `true`,
+ * `image` will only contain the repainted area. `onlyDirty` defaults to `false`.
*/
beginFrameSubscription(callback: (image: NativeImage, dirtyRect: Rectangle) => void): void;
/**
- * Begin subscribing for presentation events and captured frames, the callback will
- * be called with callback(image, dirtyRect) when there is a presentation event.
- * The image is an instance of NativeImage that stores the captured frame. The
- * dirtyRect is an object with x, y, width, height properties that describes which
- * part of the page was repainted. If onlyDirty is set to true, image will only
- * contain the repainted area. onlyDirty defaults to false.
+ * Begin subscribing for presentation events and captured frames, the `callback`
+ * will be called with `callback(image, dirtyRect)` when there is a presentation
+ * event.
+ *
+ * The `image` is an instance of NativeImage that stores the captured frame.
+ *
+ * The `dirtyRect` is an object with `x, y, width, height` properties that
+ * describes which part of the page was repainted. If `onlyDirty` is set to `true`,
+ * `image` will only contain the repainted area. `onlyDirty` defaults to `false`.
*/
beginFrameSubscription(onlyDirty: boolean, callback: (image: NativeImage, dirtyRect: Rectangle) => void): void;
+ /**
+ * Whether the browser can go back to previous web page.
+ */
canGoBack(): boolean;
+ /**
+ * Whether the browser can go forward to next web page.
+ */
canGoForward(): boolean;
+ /**
+ * Whether the web page can go to `offset`.
+ */
canGoToOffset(offset: number): boolean;
/**
- * Captures a snapshot of the page within rect. Omitting rect will capture the
+ * Resolves with a NativeImage
+ *
+ * Captures a snapshot of the page within `rect`. Omitting `rect` will capture the
* whole visible page.
*/
capturePage(rect?: Rectangle): Promise<Electron.NativeImage>;
@@ -6618,7 +7872,7 @@ declare namespace Electron {
*/
closeDevTools(): void;
/**
- * Executes the editing command copy in web page.
+ * Executes the editing command `copy` in web page.
*/
copy(): void;
/**
@@ -6626,20 +7880,20 @@ declare namespace Electron {
*/
copyImageAt(x: number, y: number): void;
/**
- * Executes the editing command cut in web page.
+ * Executes the editing command `cut` in web page.
*/
cut(): void;
/**
- * Executes the editing command delete in web page.
+ * Executes the editing command `delete` in web page.
*/
delete(): void;
/**
- * Disable device emulation enabled by webContents.enableDeviceEmulation.
+ * Disable device emulation enabled by `webContents.enableDeviceEmulation`.
*/
disableDeviceEmulation(): void;
/**
- * Initiates a download of the resource at url without navigating. The
- * will-download event of session will be triggered.
+ * Initiates a download of the resource at `url` without navigating. The
+ * `will-download` event of `session` will be triggered.
*/
downloadURL(url: string): void;
/**
@@ -6651,33 +7905,75 @@ declare namespace Electron {
*/
endFrameSubscription(): void;
/**
- * Evaluates code in page. In the browser window some HTML APIs like
- * requestFullScreen can only be invoked by a gesture from the user. Setting
- * userGesture to true will remove this limitation.
+ * A promise that resolves with the result of the executed code or is rejected if
+ * the result of the code is a rejected promise.
+ *
+ * Evaluates `code` in page.
+ *
+ * In the browser window some HTML APIs like `requestFullScreen` can only be
+ * invoked by a gesture from the user. Setting `userGesture` to `true` will remove
+ * this limitation.
*/
executeJavaScript(code: string, userGesture?: boolean): Promise<any>;
/**
- * Starts a request to find all matches for the text in the web page. The result of
- * the request can be obtained by subscribing to found-in-page event.
+ * The request id used for the request.
+ *
+ * Starts a request to find all matches for the `text` in the web page. The result
+ * of the request can be obtained by subscribing to `found-in-page` event.
*/
findInPage(text: string, options?: FindInPageOptions): number;
/**
* Focuses the web page.
*/
focus(): void;
+ /**
+ * If *offscreen rendering* is enabled returns the current frame rate.
+ */
getFrameRate(): number;
+ /**
+ * The operating system `pid` of the associated renderer process.
+ */
getOSProcessId(): number;
/**
* Get the system printer list.
+
+Returns `PrinterInfo[]`.
+ */
+ getPrinters(): void;
+ /**
+ * The Chromium internal `pid` of the associated renderer. Can be compared to the
+ * `frameProcessId` passed by frame specific navigation events (e.g.
+ * `did-frame-navigate`)
*/
- getPrinters(): PrinterInfo[];
getProcessId(): number;
+ /**
+ * The title of the current web page.
+ */
getTitle(): string;
+ /**
+ * the type of the webContent. Can be `backgroundPage`, `window`, `browserView`,
+ * `remote`, `webview` or `offscreen`.
+ */
getType(): ('backgroundPage' | 'window' | 'browserView' | 'remote' | 'webview' | 'offscreen');
+ /**
+ * The URL of the current web page.
+ */
getURL(): string;
+ /**
+ * The user agent for this web page.
+ */
getUserAgent(): string;
+ /**
+ * Returns the WebRTC IP Handling Policy.
+ */
getWebRTCIPHandlingPolicy(): string;
+ /**
+ * the current zoom factor.
+ */
getZoomFactor(): number;
+ /**
+ * the current zoom level.
+ */
getZoomLevel(): number;
/**
* Makes the browser go back a web page.
@@ -6700,11 +7996,11 @@ declare namespace Electron {
*/
insertCSS(css: string): void;
/**
- * Inserts text to the focused element.
+ * Inserts `text` to the focused element.
*/
insertText(text: string): void;
/**
- * Starts inspecting element at position (x, y).
+ * Starts inspecting element at position (`x`, `y`).
*/
inspectElement(x: number, y: number): void;
/**
@@ -6716,67 +8012,125 @@ declare namespace Electron {
*/
inspectSharedWorker(): void;
/**
- * Schedules a full repaint of the window this web contents is in. If offscreen
- * rendering is enabled invalidates the frame and generates a new one through the
- * 'paint' event.
+ * Schedules a full repaint of the window this web contents is in.
+ *
+ * If *offscreen rendering* is enabled invalidates the frame and generates a new
+ * one through the `'paint'` event.
*/
invalidate(): void;
+ /**
+ * Whether this page has been muted.
+ */
isAudioMuted(): boolean;
+ /**
+ * Whether the renderer process has crashed.
+ */
isCrashed(): boolean;
+ /**
+ * Whether audio is currently playing.
+ */
isCurrentlyAudible(): boolean;
+ /**
+ * Whether the web page is destroyed.
+ */
isDestroyed(): boolean;
+ /**
+ * Whether the devtools view is focused .
+ */
isDevToolsFocused(): boolean;
+ /**
+ * Whether the devtools is opened.
+ */
isDevToolsOpened(): boolean;
+ /**
+ * Whether the web page is focused.
+ */
isFocused(): boolean;
+ /**
+ * Whether web page is still loading resources.
+ */
isLoading(): boolean;
+ /**
+ * Whether the main frame (and not just iframes or frames within it) is still
+ * loading.
+ */
isLoadingMainFrame(): boolean;
+ /**
+ * Indicates whether *offscreen rendering* is enabled.
+ */
isOffscreen(): boolean;
+ /**
+ * If *offscreen rendering* is enabled returns whether it is currently painting.
+ */
isPainting(): boolean;
+ /**
+ * Whether the web page is waiting for a first-response from the main resource of
+ * the page.
+ */
isWaitingForResponse(): boolean;
/**
- * Loads the given file in the window, filePath should be a path to an HTML file
+ * the promise will resolve when the page has finished loading (see
+ * `did-finish-load`), and rejects if the page fails to load (see `did-fail-load`).
+ *
+ * Loads the given file in the window, `filePath` should be a path to an HTML file
* relative to the root of your application. For instance an app structure like
- * this: Would require code like this
+ * this:
+
+Would require code like this
*/
loadFile(filePath: string, options?: LoadFileOptions): Promise<void>;
/**
- * Loads the url in the window. The url must contain the protocol prefix, e.g. the
- * http:// or file://. If the load should bypass http cache then use the pragma
- * header to achieve it.
+ * the promise will resolve when the page has finished loading (see
+ * `did-finish-load`), and rejects if the page fails to load (see `did-fail-load`).
+ *
+ * Loads the `url` in the window. The `url` must contain the protocol prefix, e.g.
+ * the `http://` or `file://`. If the load should bypass http cache then use the
+ * `pragma` header to achieve it.
*/
loadURL(url: string, options?: LoadURLOptions): Promise<void>;
/**
- * Opens the devtools. When contents is a <webview> tag, the mode would be detach
- * by default, explicitly passing an empty mode can force using last used dock
- * state.
+ * Opens the devtools.
+ *
+ * When `contents` is a `<webview>` tag, the `mode` would be `detach` by default,
+ * explicitly passing an empty `mode` can force using last used dock state.
*/
openDevTools(options?: OpenDevToolsOptions): void;
/**
- * Executes the editing command paste in web page.
+ * Executes the editing command `paste` in web page.
*/
paste(): void;
/**
- * Executes the editing command pasteAndMatchStyle in web page.
+ * Executes the editing command `pasteAndMatchStyle` in web page.
*/
pasteAndMatchStyle(): void;
/**
- * Prints window's web page. When silent is set to true, Electron will pick the
- * system's default printer if deviceName is empty and the default settings for
- * printing. Calling window.print() in web page is equivalent to calling
- * webContents.print({ silent: false, printBackground: false, deviceName: '' }).
- * Use page-break-before: always; CSS style to force to print to a new page.
+ * Prints window's web page. When `silent` is set to `true`, Electron will pick the
+ * system's default printer if `deviceName` is empty and the default settings for
+ * printing.
+ *
+ * Calling `window.print()` in web page is equivalent to calling
+ * `webContents.print({ silent: false, printBackground: false, deviceName: '' })`.
+ *
+Use `page-break-before: always;` CSS style to force to print to a new page.
*/
print(options?: PrintOptions, callback?: (success: boolean) => void): void;
/**
+ * Resolves with the generated PDF data.
+ *
* Prints window's web page as PDF with Chromium's preview printing custom
- * settings. The landscape will be ignored if @page CSS at-rule is used in the web
- * page. By default, an empty options will be regarded as: Use page-break-before:
- * always; CSS style to force to print to a new page. An example of
- * webContents.printToPDF:
+ * settings.
+ *
+ * The `landscape` will be ignored if `@page` CSS at-rule is used in the web page.
+ *
+ * By default, an empty `options` will be regarded as:
+ *
+ * Use `page-break-before: always;` CSS style to force to print to a new page.
+ *
+An example of `webContents.printToPDF`:
*/
printToPDF(options: PrintToPDFOptions): Promise<Buffer>;
/**
- * Executes the editing command redo in web page.
+ * Executes the editing command `redo` in web page.
*/
redo(): void;
/**
@@ -6792,42 +8146,76 @@ declare namespace Electron {
*/
removeWorkSpace(path: string): void;
/**
- * Executes the editing command replace in web page.
+ * Executes the editing command `replace` in web page.
*/
replace(text: string): void;
/**
- * Executes the editing command replaceMisspelling in web page.
+ * Executes the editing command `replaceMisspelling` in web page.
*/
replaceMisspelling(text: string): void;
+ /**
+ * resolves if the page is saved.
+ */
savePage(fullPath: string, saveType: 'HTMLOnly' | 'HTMLComplete' | 'MHTML'): Promise<void>;
/**
- * Executes the editing command selectAll in web page.
+ * Executes the editing command `selectAll` in web page.
*/
selectAll(): void;
/**
- * Send an asynchronous message to renderer process via channel, you can also send
- * arbitrary arguments. Arguments will be serialized in JSON internally and hence
- * no functions or prototype chain will be included. The renderer process can
- * handle the message by listening to channel with the ipcRenderer module. An
- * example of sending messages from the main process to the renderer process:
+ * Send an asynchronous message to renderer process via `channel`, you can also
+ * send arbitrary arguments. Arguments will be serialized in JSON internally and
+ * hence no functions or prototype chain will be included.
+ *
+ * The renderer process can handle the message by listening to `channel` with the
+ * `ipcRenderer` module.
+ *
+An example of sending messages from the main process to the renderer process:
*/
send(channel: string, ...args: any[]): void;
/**
- * Sends an input event to the page. Note: The BrowserWindow containing the
- * contents needs to be focused for sendInputEvent() to work. For keyboard events,
- * the event object also have following properties: For mouse events, the event
- * object also have following properties: For the mouseWheel event, the event
- * object also have following properties:
+ * Sends an input `event` to the page. **Note:** The `BrowserWindow` containing the
+ * contents needs to be focused for `sendInputEvent()` to work.
+ *
+ * For keyboard events, the `event` object also have following properties:
+ *
+ * * `keyCode` String (**required**) - The character that will be sent as the
+ * keyboard event. Should only use the valid key codes in Accelerator.
+ *
+ * For mouse events, the `event` object also have following properties:
+ *
+ * * `x` Integer (**required**)
+ * * `y` Integer (**required**)
+ * * `button` String - The button pressed, can be `left`, `middle`, `right`.
+ * * `globalX` Integer
+ * * `globalY` Integer
+ * * `movementX` Integer
+ * * `movementY` Integer
+ * * `clickCount` Integer
+ *
+ * For the `mouseWheel` event, the `event` object also have following properties:
+ *
+ * * `deltaX` Integer
+ * * `deltaY` Integer
+ * * `wheelTicksX` Integer
+ * * `wheelTicksY` Integer
+ * * `accelerationRatioX` Integer
+ * * `accelerationRatioY` Integer
+ * * `hasPreciseScrollingDeltas` Boolean
+* `canScroll` Boolean
*/
sendInputEvent(event: Event): void;
/**
* Send an asynchronous message to a specific frame in a renderer process via
- * channel. Arguments will be serialized as JSON internally and as such no
- * functions or prototype chains will be included. The renderer process can handle
- * the message by listening to channel with the ipcRenderer module. If you want to
- * get the frameId of a given renderer context you should use the
- * webFrame.routingId value. E.g. You can also read frameId from all incoming IPC
- * messages in the main process.
+ * `channel`. Arguments will be serialized as JSON internally and as such no
+ * functions or prototype chains will be included.
+ *
+ * The renderer process can handle the message by listening to `channel` with the
+ * `ipcRenderer` module.
+ *
+ * If you want to get the `frameId` of a given renderer context you should use the
+ * `webFrame.routingId` value. E.g.
+ *
+You can also read `frameId` from all incoming IPC messages in the main process.
*/
sendToFrame(frameId: number, channel: string, ...args: any[]): void;
/**
@@ -6840,20 +8228,27 @@ declare namespace Electron {
*/
setBackgroundThrottling(allowed: boolean): void;
/**
- * Uses the devToolsWebContents as the target WebContents to show devtools. The
- * devToolsWebContents must not have done any navigation, and it should not be used
- * for other purposes after the call. By default Electron manages the devtools by
- * creating an internal WebContents with native view, which developers have very
- * limited control of. With the setDevToolsWebContents method, developers can use
- * any WebContents to show the devtools in it, including BrowserWindow, BrowserView
- * and <webview> tag. Note that closing the devtools does not destroy the
- * devToolsWebContents, it is caller's responsibility to destroy
- * devToolsWebContents. An example of showing devtools in a <webview> tag: An
- * example of showing devtools in a BrowserWindow:
+ * Uses the `devToolsWebContents` as the target `WebContents` to show devtools.
+ *
+ * The `devToolsWebContents` must not have done any navigation, and it should not
+ * be used for other purposes after the call.
+ *
+ * By default Electron manages the devtools by creating an internal `WebContents`
+ * with native view, which developers have very limited control of. With the
+ * `setDevToolsWebContents` method, developers can use any `WebContents` to show
+ * the devtools in it, including `BrowserWindow`, `BrowserView` and `<webview>`
+ * tag.
+ *
+ * Note that closing the devtools does not destroy the `devToolsWebContents`, it is
+ * caller's responsibility to destroy `devToolsWebContents`.
+ *
+ * An example of showing devtools in a `<webview>` tag:
+ *
+An example of showing devtools in a `BrowserWindow`:
*/
setDevToolsWebContents(devToolsWebContents: WebContents): void;
/**
- * If offscreen rendering is enabled sets the frame rate to the specified number.
+ * If *offscreen rendering* is enabled sets the frame rate to the specified number.
* Only values between 1 and 60 are accepted.
*/
setFrameRate(fps: number): void;
@@ -6871,6 +8266,9 @@ declare namespace Electron {
setUserAgent(userAgent: string): void;
/**
* Sets the maximum and minimum pinch-to-zoom level.
+ *
+ * > **NOTE**: Visual zoom is disabled by default in Electron. To re-enable it,
+ * call:
*/
setVisualZoomLevelLimits(minimumLevel: number, maximumLevel: number): void;
/**
@@ -6887,7 +8285,7 @@ declare namespace Electron {
* Changes the zoom level to the specified level. The original size is 0 and each
* increment above or below represents zooming 20% larger or smaller to default
* limits of 300% and 50% of original size, respectively. The formula for this is
- * scale := 1.2 ^ level.
+ * `scale := 1.2 ^ level`.
*/
setZoomLevel(level: number): void;
/**
@@ -6895,13 +8293,13 @@ declare namespace Electron {
*/
showDefinitionForSelection(): void;
/**
- * Sets the item as dragging item for current drag-drop operation, file is the
- * absolute path of the file to be dragged, and icon is the image showing under the
- * cursor when dragging.
+ * Sets the `item` as dragging item for current drag-drop operation, `file` is the
+ * absolute path of the file to be dragged, and `icon` is the image showing under
+ * the cursor when dragging.
*/
startDrag(item: Item): void;
/**
- * If offscreen rendering is enabled and not painting, start painting.
+ * If *offscreen rendering* is enabled and not painting, start painting.
*/
startPainting(): void;
/**
@@ -6909,15 +8307,17 @@ declare namespace Electron {
*/
stop(): void;
/**
- * Stops any findInPage request for the webContents with the provided action.
+ * Stops any `findInPage` request for the `webContents` with the provided `action`.
*/
stopFindInPage(action: 'clearSelection' | 'keepSelection' | 'activateSelection'): void;
/**
- * If offscreen rendering is enabled and painting, stop painting.
+ * If *offscreen rendering* is enabled and painting, stop painting.
*/
stopPainting(): void;
/**
- * Takes a V8 heap snapshot and saves it to filePath.
+ * Indicates whether the snapshot has been created successfully.
+ *
+Takes a V8 heap snapshot and saves it to `filePath`.
*/
takeHeapSnapshot(filePath: string): Promise<void>;
/**
@@ -6925,11 +8325,11 @@ declare namespace Electron {
*/
toggleDevTools(): void;
/**
- * Executes the editing command undo in web page.
+ * Executes the editing command `undo` in web page.
*/
undo(): void;
/**
- * Executes the editing command unselect in web page.
+ * Executes the editing command `unselect` in web page.
*/
unselect(): void;
debugger: Debugger;
@@ -6939,45 +8339,82 @@ declare namespace Electron {
session: Session;
}
- interface WebFrame extends EventEmitter {
+ interface WebFrame extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/web-frame
/**
* Attempts to free memory that is no longer being used (like images from a
- * previous navigation). Note that blindly calling this method probably makes
- * Electron slower since it will have to refill these emptied caches, you should
- * only call it if an event in your app has occurred that makes you think your page
- * is actually using less memory (i.e. you have navigated from a super heavy page
- * to a mostly empty one, and intend to stay there).
+ * previous navigation).
+ *
+ * Note that blindly calling this method probably makes Electron slower since it
+ * will have to refill these emptied caches, you should only call it if an event in
+ * your app has occurred that makes you think your page is actually using less
+ * memory (i.e. you have navigated from a super heavy page to a mostly empty one,
+ * and intend to stay there).
*/
clearCache(): void;
/**
- * Evaluates code in page. In the browser window some HTML APIs like
- * requestFullScreen can only be invoked by a gesture from the user. Setting
- * userGesture to true will remove this limitation.
+ * A promise that resolves with the result of the executed code or is rejected if
+ * the result of the code is a rejected promise.
+ *
+ * Evaluates `code` in page.
+ *
+ * In the browser window some HTML APIs like `requestFullScreen` can only be
+ * invoked by a gesture from the user. Setting `userGesture` to `true` will remove
+ * this limitation.
*/
executeJavaScript(code: string, userGesture?: boolean): Promise<any>;
/**
- * Works like executeJavaScript but evaluates scripts in an isolated context.
+ * A promise that resolves with the result of the executed code or is rejected if
+ * the result of the code is a rejected promise.
+ *
+Works like `executeJavaScript` but evaluates `scripts` in an isolated context.
*/
executeJavaScriptInIsolatedWorld(worldId: number, scripts: WebSource[], userGesture?: boolean): Promise<any>;
+ /**
+ * A child of `webFrame` with the supplied `name`, `null` would be returned if
+ * there's no such frame or if the frame is not in the current renderer process.
+ */
findFrameByName(name: string): WebFrame;
+ /**
+ * that has the supplied `routingId`, `null` if not found.
+ */
findFrameByRoutingId(routingId: number): WebFrame;
+ /**
+ * The frame element in `webFrame's` document selected by `selector`, `null` would
+ * be returned if `selector` does not select a frame or if the frame is not in the
+ * current renderer process.
+ */
getFrameForSelector(selector: string): WebFrame;
/**
+ * * `images` MemoryUsageDetails
+ * * `scripts` MemoryUsageDetails
+ * * `cssStyleSheets` MemoryUsageDetails
+ * * `xslStyleSheets` MemoryUsageDetails
+ * * `fonts` MemoryUsageDetails
+ * * `other` MemoryUsageDetails
+ *
* Returns an object describing usage information of Blink's internal memory
- * caches. This will generate:
+ * caches.
+
+This will generate:
*/
getResourceUsage(): ResourceUsage;
+ /**
+ * The current zoom factor.
+ */
getZoomFactor(): number;
+ /**
+ * The current zoom level.
+ */
getZoomLevel(): number;
/**
- * Inserts css as a style sheet in the document.
+ * Inserts `css` as a style sheet in the document.
*/
insertCSS(css: string): void;
/**
- * Inserts text to the focused element.
+ * Inserts `text` to the focused element.
*/
insertText(text: string): void;
/**
@@ -6990,7 +8427,8 @@ declare namespace Electron {
setIsolatedWorldHumanReadableName(worldId: number, name: string): void;
/**
* Set the security origin, content security policy and name of the isolated world.
- * Note: If the csp is specified, then the securityOrigin also has to be specified.
+ * Note: If the `csp` is specified, then the `securityOrigin` also has to be
+ * specified.
*/
setIsolatedWorldInfo(worldId: number, info: Info): void;
/**
@@ -7002,15 +8440,21 @@ declare namespace Electron {
*/
setLayoutZoomLevelLimits(minimumLevel: number, maximumLevel: number): void;
/**
- * Sets a provider for spell checking in input fields and text areas. The provider
- * must be an object that has a spellCheck method that accepts an array of
- * individual words for spellchecking. The spellCheck function runs asynchronously
- * and calls the callback function with an array of misspelt words when complete.
- * An example of using node-spellchecker as provider:
+ * Sets a provider for spell checking in input fields and text areas.
+ *
+ * The `provider` must be an object that has a `spellCheck` method that accepts an
+ * array of individual words for spellchecking. The `spellCheck` function runs
+ * asynchronously and calls the `callback` function with an array of misspelt words
+ * when complete.
+
+An example of using node-spellchecker as provider:
*/
setSpellCheckProvider(language: string, provider: Provider): void;
/**
* Sets the maximum and minimum pinch-to-zoom level.
+ *
+ * > **NOTE**: Visual zoom is disabled by default in Electron. To re-enable it,
+ * call:
*/
setVisualZoomLevelLimits(minimumLevel: number, maximumLevel: number): void;
/**
@@ -7025,132 +8469,145 @@ declare namespace Electron {
*/
setZoomLevel(level: number): void;
/**
- * A WebFrame representing the first child frame of webFrame, the property would be
- * null if webFrame has no children or if first child is not in the current
- * renderer process.
+ * A `WebFrame` representing the first child frame of `webFrame`, the property
+ * would be `null` if `webFrame` has no children or if first child is not in the
+ * current renderer process.
*/
- firstChild?: WebFrame;
+ firstChild: WebFrame;
/**
- * A WebFrame representing next sibling frame, the property would be null if
- * webFrame is the last frame in its parent or if the next sibling is not in the
+ * A `WebFrame` representing next sibling frame, the property would be `null` if
+ * `webFrame` is the last frame in its parent or if the next sibling is not in the
* current renderer process.
*/
- nextSibling?: WebFrame;
+ nextSibling: WebFrame;
/**
- * A WebFrame representing the frame which opened webFrame, the property would be
- * null if there's no opener or opener is not in the current renderer process.
+ * A `WebFrame` representing the frame which opened `webFrame`, the property would
+ * be `null` if there's no opener or opener is not in the current renderer process.
*/
- opener?: WebFrame;
+ opener: WebFrame;
/**
- * A WebFrame representing parent frame of webFrame, the property would be null if
- * webFrame is top or parent is not in the current renderer process.
+ * A `WebFrame` representing parent frame of `webFrame`, the property would be
+ * `null` if `webFrame` is top or parent is not in the current renderer process.
*/
- parent?: WebFrame;
+ parent: WebFrame;
/**
- * An Integer representing the unique frame id in the current renderer process.
+ * An `Integer` representing the unique frame id in the current renderer process.
* Distinct WebFrame instances that refer to the same underlying frame will have
- * the same routingId.
+ * the same `routingId`.
*/
- routingId?: number;
+ routingId: number;
/**
- * A WebFrame representing top frame in frame hierarchy to which webFrame belongs,
- * the property would be null if top frame is not in the current renderer process.
+ * A `WebFrame` representing top frame in frame hierarchy to which `webFrame`
+ * belongs, the property would be `null` if top frame is not in the current
+ * renderer process.
*/
- top?: WebFrame;
+ top: WebFrame;
}
- class WebRequest extends EventEmitter {
+ class WebRequest extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/web-request
/**
- * The listener will be called with listener(details) when a server initiated
+ * The `listener` will be called with `listener(details)` when a server initiated
* redirect is about to occur.
*/
- onBeforeRedirect(listener: ((details: OnBeforeRedirectDetails) => void) | (null)): void;
+ onBeforeRedirect(listener: ((details: OnBeforeRedirectListenerDetails) => void) | (null)): void;
/**
- * The listener will be called with listener(details) when a server initiated
+ * The `listener` will be called with `listener(details)` when a server initiated
* redirect is about to occur.
*/
- onBeforeRedirect(filter: OnBeforeRedirectFilter, listener: ((details: OnBeforeRedirectDetails) => void) | (null)): void;
+ onBeforeRedirect(filter: OnBeforeRedirectFilter, listener: ((details: OnBeforeRedirectListenerDetails) => void) | (null)): void;
/**
- * The listener will be called with listener(details, callback) when a request is
- * about to occur. The uploadData is an array of UploadData objects. The callback
- * has to be called with an response object.
+ * The `listener` will be called with `listener(details, callback)` when a request
+ * is about to occur.
+ *
+ * The `uploadData` is an array of `UploadData` objects.
+ *
+The `callback` has to be called with an `response` object.
*/
- onBeforeRequest(listener: ((details: OnBeforeRequestDetails, callback: (response: Response) => void) => void) | (null)): void;
+ onBeforeRequest(listener: ((details: OnBeforeRequestListenerDetails, callback: (response: Response) => void) => void) | (null)): void;
/**
- * The listener will be called with listener(details, callback) when a request is
- * about to occur. The uploadData is an array of UploadData objects. The callback
- * has to be called with an response object.
+ * The `listener` will be called with `listener(details, callback)` when a request
+ * is about to occur.
+ *
+ * The `uploadData` is an array of `UploadData` objects.
+ *
+The `callback` has to be called with an `response` object.
*/
- onBeforeRequest(filter: OnBeforeRequestFilter, listener: ((details: OnBeforeRequestDetails, callback: (response: Response) => void) => void) | (null)): void;
+ onBeforeRequest(filter: OnBeforeRequestFilter, listener: ((details: OnBeforeRequestListenerDetails, callback: (response: Response) => void) => void) | (null)): void;
/**
- * The listener will be called with listener(details, callback) before sending an
- * HTTP request, once the request headers are available. This may occur after a TCP
- * connection is made to the server, but before any http data is sent. The callback
- * has to be called with an response object.
+ * The `listener` will be called with `listener(details, callback)` before sending
+ * an HTTP request, once the request headers are available. This may occur after a
+ * TCP connection is made to the server, but before any http data is sent.
+ *
+The `callback` has to be called with an `response` object.
*/
- onBeforeSendHeaders(filter: OnBeforeSendHeadersFilter, listener: ((details: OnBeforeSendHeadersDetails, callback: (response: OnBeforeSendHeadersResponse) => void) => void) | (null)): void;
+ onBeforeSendHeaders(filter: OnBeforeSendHeadersFilter, listener: ((details: OnBeforeSendHeadersListenerDetails, callback: (response: CallbackResponse) => void) => void) | (null)): void;
/**
- * The listener will be called with listener(details, callback) before sending an
- * HTTP request, once the request headers are available. This may occur after a TCP
- * connection is made to the server, but before any http data is sent. The callback
- * has to be called with an response object.
+ * The `listener` will be called with `listener(details, callback)` before sending
+ * an HTTP request, once the request headers are available. This may occur after a
+ * TCP connection is made to the server, but before any http data is sent.
+ *
+The `callback` has to be called with an `response` object.
*/
- onBeforeSendHeaders(listener: ((details: OnBeforeSendHeadersDetails, callback: (response: OnBeforeSendHeadersResponse) => void) => void) | (null)): void;
+ onBeforeSendHeaders(listener: ((details: OnBeforeSendHeadersListenerDetails, callback: (response: CallbackResponse) => void) => void) | (null)): void;
/**
- * The listener will be called with listener(details) when a request is completed.
+ * The `listener` will be called with `listener(details)` when a request is
+ * completed.
*/
- onCompleted(filter: OnCompletedFilter, listener: ((details: OnCompletedDetails) => void) | (null)): void;
+ onCompleted(filter: OnCompletedFilter, listener: ((details: OnCompletedListenerDetails) => void) | (null)): void;
/**
- * The listener will be called with listener(details) when a request is completed.
+ * The `listener` will be called with `listener(details)` when a request is
+ * completed.
*/
- onCompleted(listener: ((details: OnCompletedDetails) => void) | (null)): void;
+ onCompleted(listener: ((details: OnCompletedListenerDetails) => void) | (null)): void;
/**
- * The listener will be called with listener(details) when an error occurs.
+ * The `listener` will be called with `listener(details)` when an error occurs.
*/
- onErrorOccurred(listener: ((details: OnErrorOccurredDetails) => void) | (null)): void;
+ onErrorOccurred(listener: ((details: OnErrorOccurredListenerDetails) => void) | (null)): void;
/**
- * The listener will be called with listener(details) when an error occurs.
+ * The `listener` will be called with `listener(details)` when an error occurs.
*/
- onErrorOccurred(filter: OnErrorOccurredFilter, listener: ((details: OnErrorOccurredDetails) => void) | (null)): void;
+ onErrorOccurred(filter: OnErrorOccurredFilter, listener: ((details: OnErrorOccurredListenerDetails) => void) | (null)): void;
/**
- * The listener will be called with listener(details, callback) when HTTP response
- * headers of a request have been received. The callback has to be called with an
- * response object.
+ * The `listener` will be called with `listener(details, callback)` when HTTP
+ * response headers of a request have been received.
+ *
+The `callback` has to be called with an `response` object.
*/
- onHeadersReceived(filter: OnHeadersReceivedFilter, listener: ((details: OnHeadersReceivedDetails, callback: (response: OnHeadersReceivedResponse) => void) => void) | (null)): void;
+ onHeadersReceived(filter: OnHeadersReceivedFilter, listener: ((details: OnHeadersReceivedListenerDetails, callback: (response: CallbackResponse) => void) => void) | (null)): void;
/**
- * The listener will be called with listener(details, callback) when HTTP response
- * headers of a request have been received. The callback has to be called with an
- * response object.
+ * The `listener` will be called with `listener(details, callback)` when HTTP
+ * response headers of a request have been received.
+ *
+The `callback` has to be called with an `response` object.
*/
- onHeadersReceived(listener: ((details: OnHeadersReceivedDetails, callback: (response: OnHeadersReceivedResponse) => void) => void) | (null)): void;
+ onHeadersReceived(listener: ((details: OnHeadersReceivedListenerDetails, callback: (response: CallbackResponse) => void) => void) | (null)): void;
/**
- * The listener will be called with listener(details) when first byte of the
+ * The `listener` will be called with `listener(details)` when first byte of the
* response body is received. For HTTP requests, this means that the status line
* and response headers are available.
*/
- onResponseStarted(listener: ((details: OnResponseStartedDetails) => void) | (null)): void;
+ onResponseStarted(listener: ((details: OnResponseStartedListenerDetails) => void) | (null)): void;
/**
- * The listener will be called with listener(details) when first byte of the
+ * The `listener` will be called with `listener(details)` when first byte of the
* response body is received. For HTTP requests, this means that the status line
* and response headers are available.
*/
- onResponseStarted(filter: OnResponseStartedFilter, listener: ((details: OnResponseStartedDetails) => void) | (null)): void;
+ onResponseStarted(filter: OnResponseStartedFilter, listener: ((details: OnResponseStartedListenerDetails) => void) | (null)): void;
/**
- * The listener will be called with listener(details) just before a request is
- * going to be sent to the server, modifications of previous onBeforeSendHeaders
+ * The `listener` will be called with `listener(details)` just before a request is
+ * going to be sent to the server, modifications of previous `onBeforeSendHeaders`
* response are visible by the time this listener is fired.
*/
- onSendHeaders(filter: OnSendHeadersFilter, listener: ((details: OnSendHeadersDetails) => void) | (null)): void;
+ onSendHeaders(filter: OnSendHeadersFilter, listener: ((details: OnSendHeadersListenerDetails) => void) | (null)): void;
/**
- * The listener will be called with listener(details) just before a request is
- * going to be sent to the server, modifications of previous onBeforeSendHeaders
+ * The `listener` will be called with `listener(details)` just before a request is
+ * going to be sent to the server, modifications of previous `onBeforeSendHeaders`
* response are visible by the time this listener is fired.
*/
- onSendHeaders(listener: ((details: OnSendHeadersDetails) => void) | (null)): void;
+ onSendHeaders(listener: ((details: OnSendHeadersListenerDetails) => void) | (null)): void;
}
interface WebSource {
@@ -7178,13 +8635,13 @@ declare namespace Electron {
removeEventListener(event: 'load-commit', listener: (event: LoadCommitEvent) => void): this;
/**
* Fired when the navigation is done, i.e. the spinner of the tab will stop
- * spinning, and the onload event is dispatched.
+ * spinning, and the `onload` event is dispatched.
*/
addEventListener(event: 'did-finish-load', listener: (event: Event) => void, useCapture?: boolean): this;
removeEventListener(event: 'did-finish-load', listener: (event: Event) => void): this;
/**
- * This event is like did-finish-load, but fired when the load failed or was
- * cancelled, e.g. window.stop() is invoked.
+ * This event is like `did-finish-load`, but fired when the load failed or was
+ * cancelled, e.g. `window.stop()` is invoked.
*/
addEventListener(event: 'did-fail-load', listener: (event: DidFailLoadEvent) => void, useCapture?: boolean): this;
removeEventListener(event: 'did-fail-load', listener: (event: DidFailLoadEvent) => void): this;
@@ -7209,8 +8666,8 @@ declare namespace Electron {
addEventListener(event: 'dom-ready', listener: (event: Event) => void, useCapture?: boolean): this;
removeEventListener(event: 'dom-ready', listener: (event: Event) => void): this;
/**
- * Fired when page title is set during navigation. explicitSet is false when title
- * is synthesized from file url.
+ * Fired when page title is set during navigation. `explicitSet` is false when
+ * title is synthesized from file url.
*/
addEventListener(event: 'page-title-updated', listener: (event: PageTitleUpdatedEvent) => void, useCapture?: boolean): this;
removeEventListener(event: 'page-title-updated', listener: (event: PageTitleUpdatedEvent) => void): this;
@@ -7230,59 +8687,71 @@ declare namespace Electron {
addEventListener(event: 'leave-html-full-screen', listener: (event: Event) => void, useCapture?: boolean): this;
removeEventListener(event: 'leave-html-full-screen', listener: (event: Event) => void): this;
/**
- * Fired when the guest window logs a console message. The following example code
- * forwards all log messages to the embedder's console without regard for log level
- * or other properties.
+ * Fired when the guest window logs a console message.
+ *
+ * The following example code forwards all log messages to the embedder's console
+ * without regard for log level or other properties.
*/
addEventListener(event: 'console-message', listener: (event: ConsoleMessageEvent) => void, useCapture?: boolean): this;
removeEventListener(event: 'console-message', listener: (event: ConsoleMessageEvent) => void): this;
/**
- * Fired when a result is available for webview.findInPage request.
+ * Fired when a result is available for `webview.findInPage` request.
*/
addEventListener(event: 'found-in-page', listener: (event: FoundInPageEvent) => void, useCapture?: boolean): this;
removeEventListener(event: 'found-in-page', listener: (event: FoundInPageEvent) => void): this;
/**
- * Fired when the guest page attempts to open a new browser window. The following
- * example code opens the new url in system's default browser.
+ * Fired when the guest page attempts to open a new browser window.
+ *
+The following example code opens the new url in system's default browser.
*/
addEventListener(event: 'new-window', listener: (event: NewWindowEvent) => void, useCapture?: boolean): this;
removeEventListener(event: 'new-window', listener: (event: NewWindowEvent) => void): this;
/**
* Emitted when a user or the page wants to start navigation. It can happen when
- * the window.location object is changed or a user clicks a link in the page. This
- * event will not emit when the navigation is started programmatically with APIs
- * like <webview>.loadURL and <webview>.back. It is also not emitted during in-page
- * navigation, such as clicking anchor links or updating the window.location.hash.
- * Use did-navigate-in-page event for this purpose. Calling event.preventDefault()
- * does NOT have any effect.
+ * the `window.location` object is changed or a user clicks a link in the page.
+ *
+ * This event will not emit when the navigation is started programmatically with
+ * APIs like `<webview>.loadURL` and `<webview>.back`.
+ *
+ * It is also not emitted during in-page navigation, such as clicking anchor links
+ * or updating the `window.location.hash`. Use `did-navigate-in-page` event for
+ * this purpose.
+
+Calling `event.preventDefault()` does __NOT__ have any effect.
*/
addEventListener(event: 'will-navigate', listener: (event: WillNavigateEvent) => void, useCapture?: boolean): this;
removeEventListener(event: 'will-navigate', listener: (event: WillNavigateEvent) => void): this;
/**
- * Emitted when a navigation is done. This event is not emitted for in-page
- * navigations, such as clicking anchor links or updating the window.location.hash.
- * Use did-navigate-in-page event for this purpose.
+ * Emitted when a navigation is done.
+ *
+ * This event is not emitted for in-page navigations, such as clicking anchor links
+ * or updating the `window.location.hash`. Use `did-navigate-in-page` event for
+ * this purpose.
*/
addEventListener(event: 'did-navigate', listener: (event: DidNavigateEvent) => void, useCapture?: boolean): this;
removeEventListener(event: 'did-navigate', listener: (event: DidNavigateEvent) => void): this;
/**
- * Emitted when an in-page navigation happened. When in-page navigation happens,
- * the page URL changes but does not cause navigation outside of the page. Examples
- * of this occurring are when anchor links are clicked or when the DOM hashchange
- * event is triggered.
+ * Emitted when an in-page navigation happened.
+ *
+ * When in-page navigation happens, the page URL changes but does not cause
+ * navigation outside of the page. Examples of this occurring are when anchor links
+ * are clicked or when the DOM `hashchange` event is triggered.
*/
addEventListener(event: 'did-navigate-in-page', listener: (event: DidNavigateInPageEvent) => void, useCapture?: boolean): this;
removeEventListener(event: 'did-navigate-in-page', listener: (event: DidNavigateInPageEvent) => void): this;
/**
- * Fired when the guest page attempts to close itself. The following example code
- * navigates the webview to about:blank when the guest attempts to close itself.
+ * Fired when the guest page attempts to close itself.
+ *
+ * The following example code navigates the `webview` to `about:blank` when the
+ * guest attempts to close itself.
*/
addEventListener(event: 'close', listener: (event: Event) => void, useCapture?: boolean): this;
removeEventListener(event: 'close', listener: (event: Event) => void): this;
/**
* Fired when the guest page has sent an asynchronous message to embedder page.
- * With sendToHost method and ipc-message event you can communicate between guest
- * page and embedder page:
+ *
+ * With `sendToHost` method and `ipc-message` event you can communicate between
+ * guest page and embedder page:
*/
addEventListener(event: 'ipc-message', listener: (event: IpcMessageEvent) => void, useCapture?: boolean): this;
removeEventListener(event: 'ipc-message', listener: (event: IpcMessageEvent) => void): this;
@@ -7341,11 +8810,22 @@ declare namespace Electron {
addEventListener(type: string, listener: EventListenerOrEventListenerObject, useCapture?: boolean): void;
removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, useCapture?: boolean): void;
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, useCapture?: boolean): void;
+ /**
+ * Whether the guest page can go back.
+ */
canGoBack(): boolean;
+ /**
+ * Whether the guest page can go forward.
+ */
canGoForward(): boolean;
+ /**
+ * Whether the guest page can go to `offset`.
+ */
canGoToOffset(offset: number): boolean;
/**
- * Captures a snapshot of the page within rect. Omitting rect will capture the
+ * Resolves with a NativeImage
+ *
+ * Captures a snapshot of the page within `rect`. Omitting `rect` will capture the
* whole visible page.
*/
capturePage(rect?: Rectangle): Promise<Electron.NativeImage>;
@@ -7358,42 +8838,67 @@ declare namespace Electron {
*/
closeDevTools(): void;
/**
- * Executes editing command copy in page.
+ * Executes editing command `copy` in page.
*/
copy(): void;
/**
- * Executes editing command cut in page.
+ * Executes editing command `cut` in page.
*/
cut(): void;
/**
- * Executes editing command delete in page.
+ * Executes editing command `delete` in page.
*/
delete(): void;
/**
- * Initiates a download of the resource at url without navigating.
+ * Initiates a download of the resource at `url` without navigating.
*/
downloadURL(url: string): void;
/**
- * Evaluates code in page. If userGesture is set, it will create the user gesture
- * context in the page. HTML APIs like requestFullScreen, which require user
- * action, can take advantage of this option for automation.
+ * A promise that resolves with the result of the executed code or is rejected if
+ * the result of the code is a rejected promise.
+ *
+ * Evaluates `code` in page. If `userGesture` is set, it will create the user
+ * gesture context in the page. HTML APIs like `requestFullScreen`, which require
+ * user action, can take advantage of this option for automation.
*/
executeJavaScript(code: string, userGesture?: boolean): Promise<any>;
/**
- * Starts a request to find all matches for the text in the web page. The result of
- * the request can be obtained by subscribing to found-in-page event.
+ * The request id used for the request.
+ *
+ * Starts a request to find all matches for the `text` in the web page. The result
+ * of the request can be obtained by subscribing to `found-in-page` event.
*/
findInPage(text: string, options?: FindInPageOptions): number;
+ /**
+ * The title of guest page.
+ */
getTitle(): string;
+ /**
+ * The URL of guest page.
+ */
getURL(): string;
+ /**
+ * The user agent for guest page.
+ */
getUserAgent(): string;
/**
- * It depends on the remote module, it is therefore not available when this module
- * is disabled.
+ * The web contents associated with this `webview`.
+ *
+ * It depends on the `remote` module, it is therefore not available when this
+ * module is disabled.
*/
getWebContents(): WebContents;
+ /**
+ * The WebContents ID of this `webview`.
+ */
getWebContentsId(): number;
+ /**
+ * the current zoom factor.
+ */
getZoomFactor(): number;
+ /**
+ * the current zoom level.
+ */
getZoomLevel(): number;
/**
* Makes the guest page go back.
@@ -7416,11 +8921,11 @@ declare namespace Electron {
*/
insertCSS(css: string): void;
/**
- * Inserts text to the focused element.
+ * Inserts `text` to the focused element.
*/
insertText(text: string): void;
/**
- * Starts inspecting element at position (x, y) of guest page.
+ * Starts inspecting element at position (`x`, `y`) of guest page.
*/
inspectElement(x: number, y: number): void;
/**
@@ -7431,17 +8936,43 @@ declare namespace Electron {
* Opens the DevTools for the shared worker context present in the guest page.
*/
inspectSharedWorker(): void;
+ /**
+ * Whether guest page has been muted.
+ */
isAudioMuted(): boolean;
+ /**
+ * Whether the renderer process has crashed.
+ */
isCrashed(): boolean;
+ /**
+ * Whether audio is currently playing.
+ */
isCurrentlyAudible(): boolean;
+ /**
+ * Whether DevTools window of guest page is focused.
+ */
isDevToolsFocused(): boolean;
+ /**
+ * Whether guest page has a DevTools window attached.
+ */
isDevToolsOpened(): boolean;
+ /**
+ * Whether guest page is still loading resources.
+ */
isLoading(): boolean;
+ /**
+ * Whether the main frame (and not just iframes or frames within it) is still
+ * loading.
+ */
isLoadingMainFrame(): boolean;
+ /**
+ * Whether the guest page is waiting for a first-response for the main resource of
+ * the page.
+ */
isWaitingForResponse(): boolean;
/**
- * Loads the url in the webview, the url must contain the protocol prefix, e.g. the
- * http:// or file://.
+ * Loads the `url` in the webview, the `url` must contain the protocol prefix, e.g.
+ * the `http://` or `file://`.
*/
loadURL(url: string, options?: LoadURLOptions): void;
/**
@@ -7449,23 +8980,25 @@ declare namespace Electron {
*/
openDevTools(): void;
/**
- * Executes editing command paste in page.
+ * Executes editing command `paste` in page.
*/
paste(): void;
/**
- * Executes editing command pasteAndMatchStyle in page.
+ * Executes editing command `pasteAndMatchStyle` in page.
*/
pasteAndMatchStyle(): void;
/**
- * Prints webview's web page. Same as webContents.print([options]).
+ * Prints `webview`'s web page. Same as `webContents.print([options])`.
*/
print(options?: PrintOptions): void;
/**
- * Prints webview's web page as PDF, Same as webContents.printToPDF(options).
+ * Resolves with the generated PDF data.
+ *
+Prints `webview`'s web page as PDF, Same as `webContents.printToPDF(options)`.
*/
printToPDF(options: PrintToPDFOptions): Promise<Buffer>;
/**
- * Executes editing command redo in page.
+ * Executes editing command `redo` in page.
*/
redo(): void;
/**
@@ -7477,27 +9010,29 @@ declare namespace Electron {
*/
reloadIgnoringCache(): void;
/**
- * Executes editing command replace in page.
+ * Executes editing command `replace` in page.
*/
replace(text: string): void;
/**
- * Executes editing command replaceMisspelling in page.
+ * Executes editing command `replaceMisspelling` in page.
*/
replaceMisspelling(text: string): void;
/**
- * Executes editing command selectAll in page.
+ * Executes editing command `selectAll` in page.
*/
selectAll(): void;
/**
- * Send an asynchronous message to renderer process via channel, you can also send
- * arbitrary arguments. The renderer process can handle the message by listening to
- * the channel event with the ipcRenderer module. See webContents.send for
- * examples.
+ * Send an asynchronous message to renderer process via `channel`, you can also
+ * send arbitrary arguments. The renderer process can handle the message by
+ * listening to the `channel` event with the `ipcRenderer` module.
+ *
+See webContents.send for examples.
*/
send(channel: string, ...args: any[]): void;
/**
- * Sends an input event to the page. See webContents.sendInputEvent for detailed
- * description of event object.
+ * Sends an input `event` to the page.
+ *
+See webContents.sendInputEvent for detailed description of `event` object.
*/
sendInputEvent(event: any): void;
/**
@@ -7525,7 +9060,7 @@ declare namespace Electron {
* Changes the zoom level to the specified level. The original size is 0 and each
* increment above or below represents zooming 20% larger or smaller to default
* limits of 300% and 50% of original size, respectively. The formula for this is
- * scale := 1.2 ^ level.
+ * `scale := 1.2 ^ level`.
*/
setZoomLevel(level: number): void;
/**
@@ -7537,109 +9072,124 @@ declare namespace Electron {
*/
stop(): void;
/**
- * Stops any findInPage request for the webview with the provided action.
+ * Stops any `findInPage` request for the `webview` with the provided `action`.
*/
stopFindInPage(action: 'clearSelection' | 'keepSelection' | 'activateSelection'): void;
/**
- * Executes editing command undo in page.
+ * Executes editing command `undo` in page.
*/
undo(): void;
/**
- * Executes editing command unselect in page.
+ * Executes editing command `unselect` in page.
*/
unselect(): void;
/**
- * When this attribute is present the guest page will be allowed to open new
- * windows. Popups are disabled by default.
+ * A `Boolean`. When this attribute is present the guest page will be allowed to
+ * open new windows. Popups are disabled by default.
*/
- allowpopups?: string;
+ allowpopups: boolean;
/**
- * A list of strings which specifies the blink features to be disabled separated by
- * ,. The full list of supported feature strings can be found in the
- * RuntimeEnabledFeatures.json5 file.
+ * A `String` which is a list of strings which specifies the blink features to be
+ * disabled separated by `,`. The full list of supported feature strings can be
+ * found in the RuntimeEnabledFeatures.json5 file.
*/
- disableblinkfeatures?: string;
+ disableblinkfeatures: string;
/**
- * When this attribute is present the guest page will have web security disabled.
- * Web security is enabled by default.
+ * A `Boolean`. When this attribute is present the guest page will have web
+ * security disabled. Web security is enabled by default.
*/
- disablewebsecurity?: string;
+ disablewebsecurity: boolean;
/**
- * A list of strings which specifies the blink features to be enabled separated by
- * ,. The full list of supported feature strings can be found in the
- * RuntimeEnabledFeatures.json5 file.
+ * A `String` which is a list of strings which specifies the blink features to be
+ * enabled separated by `,`. The full list of supported feature strings can be
+ * found in the RuntimeEnabledFeatures.json5 file.
*/
- enableblinkfeatures?: string;
+ enableblinkfeatures: string;
/**
- * When this attribute is false the guest page in webview will not have access to
- * the remote module. The remote module is available by default.
+ * A `Boolean`. When this attribute is `false` the guest page in `webview` will not
+ * have access to the `remote` module. The remote module is available by default.
*/
- enableremotemodule?: string;
+ enableremotemodule: boolean;
/**
- * Sets the referrer URL for the guest page.
+ * A `String` that sets the referrer URL for the guest page.
*/
- httpreferrer?: string;
+ httpreferrer: string;
/**
- * When this attribute is present the guest page in webview will have node
- * integration and can use node APIs like require and process to access low level
- * system resources. Node integration is disabled by default in the guest page.
+ * A `Boolean`. When this attribute is present the guest page in `webview` will
+ * have node integration and can use node APIs like `require` and `process` to
+ * access low level system resources. Node integration is disabled by default in
+ * the guest page.
*/
- nodeintegration?: string;
+ nodeintegration: boolean;
/**
- * Experimental option for enabling NodeJS support in sub-frames such as iframes
- * inside the webview. All your preloads will load for every iframe, you can use
- * process.isMainFrame to determine if you are in the main frame or not. This
- * option is disabled by default in the guest page.
+ * A `Boolean` for the experimental option for enabling NodeJS support in
+ * sub-frames such as iframes inside the `webview`. All your preloads will load for
+ * every iframe, you can use `process.isMainFrame` to determine if you are in the
+ * main frame or not. This option is disabled by default in the guest page.
*/
- nodeintegrationinsubframes?: string;
+ nodeintegrationinsubframes: boolean;
/**
- * Sets the session used by the page. If partition starts with persist:, the page
- * will use a persistent session available to all pages in the app with the same
- * partition. if there is no persist: prefix, the page will use an in-memory
- * session. By assigning the same partition, multiple pages can share the same
- * session. If the partition is unset then default session of the app will be used.
+ * A `String` that sets the session used by the page. If `partition` starts with
+ * `persist:`, the page will use a persistent session available to all pages in the
+ * app with the same `partition`. if there is no `persist:` prefix, the page will
+ * use an in-memory session. By assigning the same `partition`, multiple pages can
+ * share the same session. If the `partition` is unset then default session of the
+ * app will be used.
+ *
* This value can only be modified before the first navigation, since the session
* of an active renderer process cannot change. Subsequent attempts to modify the
* value will fail with a DOM exception.
*/
- partition?: string;
+ partition: string;
/**
- * When this attribute is present the guest page in webview will be able to use
- * browser plugins. Plugins are disabled by default.
+ * A `Boolean`. When this attribute is present the guest page in `webview` will be
+ * able to use browser plugins. Plugins are disabled by default.
*/
- plugins?: string;
+ plugins: boolean;
/**
- * Specifies a script that will be loaded before other scripts run in the guest
- * page. The protocol of script's URL must be either file: or asar:, because it
- * will be loaded by require in guest page under the hood. When the guest page
- * doesn't have node integration this script will still have access to all Node
- * APIs, but global objects injected by Node will be deleted after this script has
- * finished executing. Note: For security reasons, preload scripts can only be
- * loaded from a subpath of the app path. Note: This option will be appear as
- * preloadURL (not preload) in the webPreferences specified to the
- * will-attach-webview event.
+ * A `String` that specifies a script that will be loaded before other scripts run
+ * in the guest page. The protocol of script's URL must be either `file:` or
+ * `asar:`, because it will be loaded by `require` in guest page under the hood.
+ *
+ * When the guest page doesn't have node integration this script will still have
+ * access to all Node APIs, but global objects injected by Node will be deleted
+ * after this script has finished executing.
+ *
+ * **Note:** For security reasons, preload scripts can only be loaded from a
+ * subpath of the app path.
+ *
+ * **Note:** This option will be appear as `preloadURL` (not `preload`) in the
+ * `webPreferences` specified to the `will-attach-webview` event.
*/
- preload?: string;
+ preload: string;
/**
- * Returns the visible URL. Writing to this attribute initiates top-level
- * navigation. Assigning src its own value will reload the current page. The src
- * attribute can also accept data URLs, such as data:text/plain,Hello, world!.
+ * A `String` representing the visible URL. Writing to this attribute initiates
+ * top-level navigation.
+ *
+ * Assigning `src` its own value will reload the current page.
+ *
+ * The `src` attribute can also accept data URLs, such as `data:text/plain,Hello,
+ * world!`.
*/
- src?: string;
+ src: string;
/**
- * Sets the user agent for the guest page before the page is navigated to. Once the
- * page is loaded, use the setUserAgent method to change the user agent.
+ * A `String` that sets the user agent for the guest page before the page is
+ * navigated to. Once the page is loaded, use the `setUserAgent` method to change
+ * the user agent.
*/
- useragent?: string;
+ useragent: string;
/**
- * A list of strings which specifies the web preferences to be set on the webview,
- * separated by ,. The full list of supported preference strings can be found in
- * BrowserWindow. The string follows the same format as the features string in
- * window.open. A name by itself is given a true boolean value. A preference can be
- * set to another value by including an =, followed by the value. Special values
- * yes and 1 are interpreted as true, while no and 0 are interpreted as false.
+ * A `String` which is a comma seperated list of strings which specifies the web
+ * preferences to be set on the webview. The full list of supported preference
+ * strings can be found in BrowserWindow.
+ *
+ * The string follows the same format as the features string in `window.open`. A
+ * name by itself is given a `true` boolean value. A preference can be set to
+ * another value by including an `=`, followed by the value. Special values `yes`
+ * and `1` are interpreted as `true`, while `no` and `0` are interpreted as
+ * `false`.
*/
- webpreferences?: string;
+ webpreferences: string;
}
interface AboutPanelOptionsOptions {
@@ -7656,19 +9206,19 @@ declare namespace Electron {
*/
copyright?: string;
/**
- * The app's build version number.
+ * The app's build version number. _macOS_
*/
version?: string;
/**
- * Credit information.
+ * Credit information. _macOS_
*/
credits?: string;
/**
- * The app's website.
+ * The app's website. _Linux_
*/
website?: string;
/**
- * Path to the app's icon.
+ * Path to the app's icon. _Linux_
*/
iconPath?: string;
}
@@ -7679,11 +9229,11 @@ declare namespace Electron {
*/
scaleFactor: number;
/**
- * Defaults to 0. Required if a bitmap buffer is specified as buffer.
+ * Defaults to 0. Required if a bitmap buffer is specified as `buffer`.
*/
width?: number;
/**
- * Defaults to 0. Required if a bitmap buffer is specified as buffer.
+ * Defaults to 0. Required if a bitmap buffer is specified as `buffer`.
*/
height?: number;
/**
@@ -7716,24 +9266,25 @@ declare namespace Electron {
interface AppDetailsOptions {
/**
- * Window's . It has to be set, otherwise the other options will have no effect.
+ * Window's App User Model ID. It has to be set, otherwise the other options will
+ * have no effect.
*/
appId?: string;
/**
- * Window's .
+ * Window's Relaunch Icon.
*/
appIconPath?: string;
/**
- * Index of the icon in appIconPath. Ignored when appIconPath is not set. Default
- * is 0.
+ * Index of the icon in `appIconPath`. Ignored when `appIconPath` is not set.
+ * Default is `0`.
*/
appIconIndex?: number;
/**
- * Window's .
+ * Window's Relaunch Command.
*/
relaunchCommand?: string;
/**
- * Window's .
+ * Window's Relaunch Display Name.
*/
relaunchDisplayName?: string;
}
@@ -7748,23 +9299,23 @@ declare namespace Electron {
interface AutoResizeOptions {
/**
- * If true, the view's width will grow and shrink together with the window. false
- * by default.
+ * If `true`, the view's width will grow and shrink together with the window.
+ * `false` by default.
*/
width: boolean;
/**
- * If true, the view's height will grow and shrink together with the window. false
- * by default.
+ * If `true`, the view's height will grow and shrink together with the window.
+ * `false` by default.
*/
height: boolean;
/**
- * If true, the view's x position and width will grow and shrink proportionly with
- * the window. false by default.
+ * If `true`, the view's x position and width will grow and shrink proportionly
+ * with the window. `false` by default.
*/
horizontal: boolean;
/**
- * If true, the view's y position and height will grow and shrink proportinaly with
- * the window. false by default.
+ * If `true`, the view's y position and height will grow and shrink proportinaly
+ * with the window. `false` by default.
*/
vertical: boolean;
}
@@ -7778,34 +9329,34 @@ declare namespace Electron {
interface BrowserViewConstructorOptions {
/**
- * See .
+ * See BrowserWindow.
*/
webPreferences?: WebPreferences;
}
interface BrowserWindowConstructorOptions {
/**
- * Window's width in pixels. Default is 800.
+ * Window's width in pixels. Default is `800`.
*/
width?: number;
/**
- * Window's height in pixels. Default is 600.
+ * Window's height in pixels. Default is `600`.
*/
height?: number;
/**
- * ( if y is used) Window's left offset from screen. Default is to center the
- * window.
+ * (**required** if y is used) Window's left offset from screen. Default is to
+ * center the window.
*/
x?: number;
/**
- * ( if x is used) Window's top offset from screen. Default is to center the
- * window.
+ * (**required** if x is used) Window's top offset from screen. Default is to
+ * center the window.
*/
y?: number;
/**
- * The width and height would be used as web page's size, which means the actual
- * window's size will include window frame's size and be slightly larger. Default
- * is false.
+ * The `width` and `height` would be used as web page's size, which means the
+ * actual window's size will include window frame's size and be slightly larger.
+ * Default is `false`.
*/
useContentSize?: boolean;
/**
@@ -7813,11 +9364,11 @@ declare namespace Electron {
*/
center?: boolean;
/**
- * Window's minimum width. Default is 0.
+ * Window's minimum width. Default is `0`.
*/
minWidth?: number;
/**
- * Window's minimum height. Default is 0.
+ * Window's minimum height. Default is `0`.
*/
minHeight?: number;
/**
@@ -7829,116 +9380,116 @@ declare namespace Electron {
*/
maxHeight?: number;
/**
- * Whether window is resizable. Default is true.
+ * Whether window is resizable. Default is `true`.
*/
resizable?: boolean;
/**
- * Whether window is movable. This is not implemented on Linux. Default is true.
+ * Whether window is movable. This is not implemented on Linux. Default is `true`.
*/
movable?: boolean;
/**
* Whether window is minimizable. This is not implemented on Linux. Default is
- * true.
+ * `true`.
*/
minimizable?: boolean;
/**
* Whether window is maximizable. This is not implemented on Linux. Default is
- * true.
+ * `true`.
*/
maximizable?: boolean;
/**
- * Whether window is closable. This is not implemented on Linux. Default is true.
+ * Whether window is closable. This is not implemented on Linux. Default is `true`.
*/
closable?: boolean;
/**
- * Whether the window can be focused. Default is true. On Windows setting
- * focusable: false also implies setting skipTaskbar: true. On Linux setting
- * focusable: false makes the window stop interacting with wm, so the window will
+ * Whether the window can be focused. Default is `true`. On Windows setting
+ * `focusable: false` also implies setting `skipTaskbar: true`. On Linux setting
+ * `focusable: false` makes the window stop interacting with wm, so the window will
* always stay on top in all workspaces.
*/
focusable?: boolean;
/**
- * Whether the window should always stay on top of other windows. Default is false.
+ * Whether the window should always stay on top of other windows. Default is
+ * `false`.
*/
alwaysOnTop?: boolean;
/**
- * Whether the window should show in fullscreen. When explicitly set to false the
- * fullscreen button will be hidden or disabled on macOS. Default is false.
+ * Whether the window should show in fullscreen. When explicitly set to `false` the
+ * fullscreen button will be hidden or disabled on macOS. Default is `false`.
*/
fullscreen?: boolean;
/**
* Whether the window can be put into fullscreen mode. On macOS, also whether the
* maximize/zoom button should toggle full screen mode or maximize window. Default
- * is true.
+ * is `true`.
*/
fullscreenable?: boolean;
/**
- * Use pre-Lion fullscreen on macOS. Default is false.
+ * Use pre-Lion fullscreen on macOS. Default is `false`.
*/
simpleFullscreen?: boolean;
/**
- * Whether to show the window in taskbar. Default is false.
+ * Whether to show the window in taskbar. Default is `false`.
*/
skipTaskbar?: boolean;
/**
- * The kiosk mode. Default is false.
+ * The kiosk mode. Default is `false`.
*/
kiosk?: boolean;
/**
- * Default window title. Default is "Electron". If the HTML tag </code> is defined
- * in the HTML file loaded by <code>loadURL()</code>, this property will be
- * ignored.</foo>
+ * Default window title. Default is `"Electron"`. If the HTML tag `<title>` is
+ * defined in the HTML file loaded by `loadURL()`, this property will be ignored.
*/
title?: string;
/**
- * The window icon. On Windows it is recommended to use ICO icons to get best
+ * The window icon. On Windows it is recommended to use `ICO` icons to get best
* visual effects, you can also leave it undefined so the executable's icon will be
* used.
*/
icon?: (NativeImage) | (string);
/**
- * Whether window should be shown when created. Default is true.
+ * Whether window should be shown when created. Default is `true`.
*/
show?: boolean;
/**
- * Specify false to create a . Default is true.
+ * Specify `false` to create a Frameless Window. Default is `true`.
*/
frame?: boolean;
/**
- * Specify parent window. Default is null.
+ * Specify parent window. Default is `null`.
*/
parent?: BrowserWindow;
/**
* Whether this is a modal window. This only works when the window is a child
- * window. Default is false.
+ * window. Default is `false`.
*/
modal?: boolean;
/**
* Whether the web view accepts a single mouse-down event that simultaneously
- * activates the window. Default is false.
+ * activates the window. Default is `false`.
*/
acceptFirstMouse?: boolean;
/**
- * Whether to hide cursor when typing. Default is false.
+ * Whether to hide cursor when typing. Default is `false`.
*/
disableAutoHideCursor?: boolean;
/**
- * Auto hide the menu bar unless the Alt key is pressed. Default is false.
+ * Auto hide the menu bar unless the `Alt` key is pressed. Default is `false`.
*/
autoHideMenuBar?: boolean;
/**
- * Enable the window to be resized larger than screen. Default is false.
+ * Enable the window to be resized larger than screen. Default is `false`.
*/
enableLargerThanScreen?: boolean;
/**
- * Window's background color as a hexadecimal value, like #66CD00 or #FFF or
- * #80FFFFFF (alpha in #AARRGGBB format is supported if transparent is set to
- * true). Default is #FFF (white).
+ * Window's background color as a hexadecimal value, like `#66CD00` or `#FFF` or
+ * `#80FFFFFF` (alpha in #AARRGGBB format is supported if `transparent` is set to
+ * `true`). Default is `#FFF` (white).
*/
backgroundColor?: string;
/**
* Whether window should have a shadow. This is only implemented on macOS. Default
- * is true.
+ * is `true`.
*/
hasShadow?: boolean;
/**
@@ -7948,11 +9499,11 @@ declare namespace Electron {
opacity?: number;
/**
* Forces using dark theme for the window, only works on some GTK+3 desktop
- * environments. Default is false.
+ * environments. Default is `false`.
*/
darkTheme?: boolean;
/**
- * Makes the window . Default is false.
+ * Makes the window transparent. Default is `false`.
*/
transparent?: boolean;
/**
@@ -7960,40 +9511,41 @@ declare namespace Electron {
*/
type?: string;
/**
- * The style of window title bar. Default is default. Possible values are:
+ * The style of window title bar. Default is `default`. Possible values are:
*/
titleBarStyle?: ('default' | 'hidden' | 'hiddenInset' | 'customButtonsOnHover');
/**
* Shows the title in the title bar in full screen mode on macOS for all
- * titleBarStyle options. Default is false.
+ * `titleBarStyle` options. Default is `false`.
*/
fullscreenWindowTitle?: boolean;
/**
- * Use WS_THICKFRAME style for frameless windows on Windows, which adds standard
- * window frame. Setting it to false will remove window shadow and window
- * animations. Default is true.
+ * Use `WS_THICKFRAME` style for frameless windows on Windows, which adds standard
+ * window frame. Setting it to `false` will remove window shadow and window
+ * animations. Default is `true`.
*/
thickFrame?: boolean;
/**
* Add a type of vibrancy effect to the window, only on macOS. Can be
- * appearance-based, light, dark, titlebar, selection, menu, popover, sidebar,
- * medium-light or ultra-dark. Please note that using frame: false in combination
- * with a vibrancy value requires that you use a non-default titleBarStyle as well.
+ * `appearance-based`, `light`, `dark`, `titlebar`, `selection`, `menu`, `popover`,
+ * `sidebar`, `medium-light` or `ultra-dark`. Please note that using `frame:
+ * false` in combination with a vibrancy value requires that you use a non-default
+ * `titleBarStyle` as well.
*/
vibrancy?: ('appearance-based' | 'light' | 'dark' | 'titlebar' | 'selection' | 'menu' | 'popover' | 'sidebar' | 'medium-light' | 'ultra-dark');
/**
* Controls the behavior on macOS when option-clicking the green stoplight button
- * on the toolbar or by clicking the Window > Zoom menu item. If true, the window
- * will grow to the preferred width of the web page when zoomed, false will cause
+ * on the toolbar or by clicking the Window > Zoom menu item. If `true`, the window
+ * will grow to the preferred width of the web page when zoomed, `false` will cause
* it to zoom to the width of the screen. This will also affect the behavior when
- * calling maximize() directly. Default is false.
+ * calling `maximize()` directly. Default is `false`.
*/
zoomToPageWidth?: boolean;
/**
* Tab group name, allows opening the window as a native tab on macOS 10.12+.
* Windows with the same tabbing identifier will be grouped together. This also
- * adds a native new tab button to your window's tab bar and allows your app and
- * window to receive the new-window-for-tab event.
+ * adds a native new tab button to your window's tab bar and allows your `app` and
+ * window to receive the `new-window-for-tab` event.
*/
tabbingIdentifier?: string;
/**
@@ -8002,6 +9554,14 @@ declare namespace Electron {
webPreferences?: WebPreferences;
}
+ interface CallbackResponse {
+ cancel?: boolean;
+ /**
+ * When provided, request will be made with these headers.
+ */
+ requestHeaders?: RequestHeaders;
+ }
+
interface CertificateTrustDialogOptions {
/**
* The certificate to trust/import.
@@ -8013,58 +9573,24 @@ declare namespace Electron {
message: string;
}
- interface CertificateVerifyProcRequest {
- hostname: string;
- certificate: Certificate;
- /**
- * Verification result from chromium.
- */
- verificationResult: string;
- /**
- * Error code.
- */
- errorCode: number;
- }
-
interface ClearStorageDataOptions {
/**
- * Should follow window.location.origin’s representation scheme://host:port.
+ * Should follow `window.location.origin`’s representation `scheme://host:port`.
*/
origin?: string;
/**
- * The types of storages to clear, can contain: appcache, cookies, filesystem,
- * indexdb, localstorage, shadercache, websql, serviceworkers, cachestorage.
+ * The types of storages to clear, can contain: `appcache`, `cookies`,
+ * `filesystem`, `indexdb`, `localstorage`, `shadercache`, `websql`,
+ * `serviceworkers`, `cachestorage`.
*/
storages?: string[];
/**
- * The types of quotas to clear, can contain: temporary, persistent, syncable.
+ * The types of quotas to clear, can contain: `temporary`, `persistent`,
+ * `syncable`.
*/
quotas?: string[];
}
- interface CommandLine {
- /**
- * Append a switch (with optional value) to Chromium's command line. Note: This
- * will not affect process.argv. The intended usage of this function is to control
- * Chromium's behavior.
- */
- appendSwitch: (the_switch: string, value?: string) => void;
- /**
- * Append an argument to Chromium's command line. The argument will be quoted
- * correctly. Switches will precede arguments regardless of appending order. If
- * you're appending an argument like --switch=value, consider using
- * appendSwitch('switch', 'value') instead. Note: This will not affect
- * process.argv. The intended usage of this function is to control Chromium's
- * behavior.
- */
- appendArgument: (value: string) => void;
- hasSwitch: (the_switch: string) => boolean;
- /**
- * Note: When the switch is not present or has no value, it returns empty string.
- */
- getSwitchValue: (the_switch: string) => string;
- }
-
interface Config {
/**
* The URL associated with the PAC file.
@@ -8119,8 +9645,8 @@ declare namespace Electron {
*/
srcURL: string;
/**
- * Type of the node the context menu was invoked on. Can be none, image, audio,
- * video, canvas, file or plugin.
+ * Type of the node the context menu was invoked on. Can be `none`, `image`,
+ * `audio`, `video`, `canvas`, `file` or `plugin`.
*/
mediaType: ('none' | 'image' | 'audio' | 'video' | 'canvas' | 'file' | 'plugin');
/**
@@ -8149,12 +9675,12 @@ declare namespace Electron {
frameCharset: string;
/**
* If the context menu was invoked on an input field, the type of that field.
- * Possible values are none, plainText, password, other.
+ * Possible values are `none`, `plainText`, `password`, `other`.
*/
inputFieldType: string;
/**
- * Input source that invoked the context menu. Can be none, mouse, keyboard, touch
- * or touchMenu.
+ * Input source that invoked the context menu. Can be `none`, `mouse`, `keyboard`,
+ * `touch` or `touchMenu`.
*/
menuSourceType: ('none' | 'mouse' | 'keyboard' | 'touch' | 'touchMenu');
/**
@@ -8175,15 +9701,15 @@ declare namespace Electron {
*/
submitURL: string;
/**
- * Defaults to app.name.
+ * Defaults to `app.name`.
*/
productName?: string;
/**
- * Whether crash reports should be sent to the server Default is true.
+ * Whether crash reports should be sent to the server Default is `true`.
*/
uploadToServer?: boolean;
/**
- * Default is false.
+ * Default is `false`.
*/
ignoreSystemCrashHandler?: boolean;
/**
@@ -8194,7 +9720,7 @@ declare namespace Electron {
extra?: Extra;
/**
* Directory to store the crashreports temporarily (only used when the crash
- * reporter is started via process.crashReporter.start).
+ * reporter is started via `process.crashReporter.start`).
*/
crashesDirectory?: string;
}
@@ -8261,7 +9787,7 @@ declare namespace Electron {
image?: NativeImage;
rtf?: string;
/**
- * The title of the url at text.
+ * The title of the url at `text`.
*/
bookmark?: string;
}
@@ -8332,52 +9858,11 @@ declare namespace Electron {
}
interface DisplayBalloonOptions {
- /**
- * -
- */
icon?: (NativeImage) | (string);
title: string;
content: string;
}
- interface Dock {
- /**
- * When critical is passed, the dock icon will bounce until either the application
- * becomes active or the request is canceled. When informational is passed, the
- * dock icon will bounce for one second. However, the request remains active until
- * either the application becomes active or the request is canceled.
- */
- bounce: (type?: 'critical' | 'informational') => number;
- /**
- * Cancel the bounce of id.
- */
- cancelBounce: (id: number) => void;
- /**
- * Bounces the Downloads stack if the filePath is inside the Downloads folder.
- */
- downloadFinished: (filePath: string) => void;
- /**
- * Sets the string to be displayed in the dock’s badging area.
- */
- setBadge: (text: string) => void;
- getBadge: () => string;
- /**
- * Hides the dock icon.
- */
- hide: () => void;
- show: () => Promise<void>;
- isVisible: () => boolean;
- /**
- * Sets the application's dock menu.
- */
- setMenu: (menu: Menu) => void;
- getMenu: () => (Menu) | (null);
- /**
- * Sets the image associated with this dock icon.
- */
- setIcon: (image: (NativeImage) | (string)) => void;
- }
-
interface EnableNetworkEmulationOptions {
/**
* Whether to emulate network outage. Defaults to false.
@@ -8407,7 +9892,7 @@ declare namespace Electron {
*/
headers?: Headers;
/**
- * Either json or default, see the README for more information.
+ * Either `json` or `default`, see the Squirrel.Mac README for more information.
*/
serverType?: string;
}
@@ -8418,7 +9903,7 @@ declare namespace Electron {
interface Filter {
/**
- * Retrieves cookies which are associated with url. Empty implies retrieving
+ * Retrieves cookies which are associated with `url`. Empty implies retrieving
* cookies of all urls.
*/
url?: string;
@@ -8427,11 +9912,11 @@ declare namespace Electron {
*/
name?: string;
/**
- * Retrieves cookies whose domains match or are subdomains of domains.
+ * Retrieves cookies whose domains match or are subdomains of `domains`.
*/
domain?: string;
/**
- * Retrieves cookies whose path matches path.
+ * Retrieves cookies whose path matches `path`.
*/
path?: string;
/**
@@ -8446,25 +9931,25 @@ declare namespace Electron {
interface FindInPageOptions {
/**
- * Whether to search forward or backward, defaults to true.
+ * Whether to search forward or backward, defaults to `true`.
*/
forward?: boolean;
/**
- * Whether the operation is first request or a follow up, defaults to false.
+ * Whether the operation is first request or a follow up, defaults to `false`.
*/
findNext?: boolean;
/**
- * Whether search should be case-sensitive, defaults to false.
+ * Whether search should be case-sensitive, defaults to `false`.
*/
matchCase?: boolean;
/**
- * Whether to look only at the start of words. defaults to false.
+ * Whether to look only at the start of words. defaults to `false`.
*/
wordStart?: boolean;
/**
- * When combined with wordStart, accepts a match in the middle of a word if the
+ * When combined with `wordStart`, accepts a match in the middle of a word if the
* match begins with an uppercase letter followed by a lowercase or non-letter.
- * Accepts several other intra-word matches, defaults to false.
+ * Accepts several other intra-word matches, defaults to `false`.
*/
medialCapitalAsWordStart?: boolean;
}
@@ -8480,11 +9965,14 @@ declare namespace Electron {
cache: boolean;
}
+ interface HandlerRequest {
+ url: string;
+ referrer: string;
+ method: string;
+ uploadData: UploadData[];
+ }
+
interface Header {
- /**
- * Specify an extra header name.
- */
- name: string;
}
interface Headers {
@@ -8505,7 +9993,7 @@ declare namespace Electron {
interface IgnoreMouseEventsOptions {
/**
* If true, forwards mouse move messages to Chromium, enabling mouse related events
- * such as mouseleave. Only used when ignore is true. If ignore is false,
+ * such as `mouseleave`. Only used when `ignore` is true. If `ignore` is false,
* forwarding is always disabled regardless of this value.
*/
forward?: boolean;
@@ -8539,76 +10027,39 @@ declare namespace Electron {
interface Input {
/**
- * Either keyUp or keyDown.
+ * Either `keyUp` or `keyDown`.
*/
type: string;
/**
- * Equivalent to .
+ * Equivalent to KeyboardEvent.key.
*/
key: string;
/**
- * Equivalent to .
+ * Equivalent to KeyboardEvent.code.
*/
code: string;
/**
- * Equivalent to .
+ * Equivalent to KeyboardEvent.repeat.
*/
isAutoRepeat: boolean;
/**
- * Equivalent to .
+ * Equivalent to KeyboardEvent.shiftKey.
*/
shift: boolean;
/**
- * Equivalent to .
+ * Equivalent to KeyboardEvent.controlKey.
*/
control: boolean;
/**
- * Equivalent to .
+ * Equivalent to KeyboardEvent.altKey.
*/
alt: boolean;
/**
- * Equivalent to .
+ * Equivalent to KeyboardEvent.metaKey.
*/
meta: boolean;
}
- interface InterceptBufferProtocolRequest {
- url: string;
- referrer: string;
- method: string;
- uploadData: UploadData[];
- }
-
- interface InterceptFileProtocolRequest {
- url: string;
- referrer: string;
- method: string;
- uploadData: UploadData[];
- }
-
- interface InterceptHttpProtocolRequest {
- url: string;
- headers: Headers;
- referrer: string;
- method: string;
- uploadData: UploadData[];
- }
-
- interface InterceptStreamProtocolRequest {
- url: string;
- headers: Headers;
- referrer: string;
- method: string;
- uploadData: UploadData[];
- }
-
- interface InterceptStringProtocolRequest {
- url: string;
- referrer: string;
- method: string;
- uploadData: UploadData[];
- }
-
interface IpcMessageEvent extends Event {
channel: string;
args: any[];
@@ -8616,9 +10067,9 @@ declare namespace Electron {
interface Item {
/**
- * or files Array The path(s) to the file(s) being dragged.
+ * The path(s) to the file(s) being dragged.
*/
- file: string;
+ file: (string[]) | (string);
/**
* The image must be non-empty on macOS.
*/
@@ -8628,14 +10079,15 @@ declare namespace Electron {
interface JumpListSettings {
/**
* The minimum number of items that will be shown in the Jump List (for a more
- * detailed description of this value see the ).
+ * detailed description of this value see the MSDN docs).
*/
minItems: number;
/**
- * Array of JumpListItem objects that correspond to items that the user has
+ * Array of `JumpListItem` objects that correspond to items that the user has
* explicitly removed from custom categories in the Jump List. These items must not
- * be re-added to the Jump List in the call to app.setJumpList(), Windows will not
- * display any custom category that contains any of the removed items.
+ * be re-added to the Jump List in the **next** call to `app.setJumpList()`,
+ * Windows will not display any custom category that contains any of the removed
+ * items.
*/
removedItems: JumpListItem[];
}
@@ -8647,15 +10099,15 @@ declare namespace Electron {
interface LoadFileOptions {
/**
- * Passed to url.format().
+ * Passed to `url.format()`.
*/
query?: Query;
/**
- * Passed to url.format().
+ * Passed to `url.format()`.
*/
search?: string;
/**
- * Passed to url.format().
+ * Passed to `url.format()`.
*/
hash?: string;
}
@@ -8676,45 +10128,45 @@ declare namespace Electron {
postData?: (UploadRawData[]) | (UploadFile[]) | (UploadBlob[]);
/**
* Base url (with trailing path separator) for files to be loaded by the data url.
- * This is needed only if the specified url is a data url and needs to load other
+ * This is needed only if the specified `url` is a data url and needs to load other
* files.
*/
baseURLForDataURL?: string;
}
interface LoginItemSettings {
- options?: Options;
/**
- * true if the app is set to open at login.
+ * `true` if the app is set to open at login.
*/
openAtLogin: boolean;
/**
- * true if the app is set to open as hidden at login. This setting is not available
- * on .
+ * `true` if the app is set to open as hidden at login. This setting is not
+ * available on MAS builds.
*/
openAsHidden: boolean;
/**
- * true if the app was opened at login automatically. This setting is not available
- * on .
+ * `true` if the app was opened at login automatically. This setting is not
+ * available on MAS builds.
*/
wasOpenedAtLogin: boolean;
/**
- * true if the app was opened as a hidden login item. This indicates that the app
- * should not open any windows at startup. This setting is not available on .
+ * `true` if the app was opened as a hidden login item. This indicates that the app
+ * should not open any windows at startup. This setting is not available on MAS
+ * builds.
*/
wasOpenedAsHidden: boolean;
/**
- * true if the app was opened as a login item that should restore the state from
+ * `true` if the app was opened as a login item that should restore the state from
* the previous session. This indicates that the app should restore the windows
* that were open the last time the app was closed. This setting is not available
- * on .
+ * on MAS builds.
*/
restoreState: boolean;
}
interface LoginItemSettingsOptions {
/**
- * The executable path to compare against. Defaults to process.execPath.
+ * The executable path to compare against. Defaults to `process.execPath`.
*/
path?: string;
/**
@@ -8728,21 +10180,22 @@ declare namespace Electron {
interface MenuItemConstructorOptions {
/**
- * Will be called with click(menuItem, browserWindow, event) when the menu item is
- * clicked.
+ * Will be called with `click(menuItem, browserWindow, event)` when the menu item
+ * is clicked.
*/
click?: (menuItem: MenuItem, browserWindow: BrowserWindow, event: KeyboardEvent) => void;
/**
- * Can be undo, redo, cut, copy, paste, pasteandmatchstyle, delete, selectall,
- * reload, forcereload, toggledevtools, resetzoom, zoomin, zoomout,
- * togglefullscreen, window, minimize, close, help, about, services, hide,
- * hideothers, unhide, quit, startspeaking, stopspeaking, close, minimize, zoom,
- * front, appMenu, fileMenu, editMenu, viewMenu or windowMenu Define the action of
- * the menu item, when specified the click property will be ignored. See .
+ * Can be `undo`, `redo`, `cut`, `copy`, `paste`, `pasteandmatchstyle`, `delete`,
+ * `selectall`, `reload`, `forcereload`, `toggledevtools`, `resetzoom`, `zoomin`,
+ * `zoomout`, `togglefullscreen`, `window`, `minimize`, `close`, `help`, `about`,
+ * `services`, `hide`, `hideothers`, `unhide`, `quit`, `startspeaking`,
+ * `stopspeaking`, `close`, `minimize`, `zoom`, `front`, `appMenu`, `fileMenu`,
+ * `editMenu`, `viewMenu` or `windowMenu` - Define the action of the menu item,
+ * when specified the `click` property will be ignored. See roles.
*/
role?: ('undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'pasteandmatchstyle' | 'delete' | 'selectall' | 'reload' | 'forcereload' | 'toggledevtools' | 'resetzoom' | 'zoomin' | 'zoomout' | 'togglefullscreen' | 'window' | 'minimize' | 'close' | 'help' | 'about' | 'services' | 'hide' | 'hideothers' | 'unhide' | 'quit' | 'startspeaking' | 'stopspeaking' | 'close' | 'minimize' | 'zoom' | 'front' | 'appMenu' | 'fileMenu' | 'editMenu' | 'viewMenu' | 'windowMenu');
/**
- * Can be normal, separator, submenu, checkbox or radio.
+ * Can be `normal`, `separator`, `submenu`, `checkbox` or `radio`.
*/
type?: ('normal' | 'separator' | 'submenu' | 'checkbox' | 'radio');
label?: string;
@@ -8754,8 +10207,8 @@ declare namespace Electron {
*/
enabled?: boolean;
/**
- * default is true, and when false will prevent the accelerator from triggering the
- * item if the item is not visible`.
+ * default is `true`, and when `false` will prevent the accelerator from triggering
+ * the item if the item is not visible`. _macOS_
*/
acceleratorWorksWhenHidden?: boolean;
/**
@@ -8763,7 +10216,7 @@ declare namespace Electron {
*/
visible?: boolean;
/**
- * Should only be specified for checkbox or radio type menu items.
+ * Should only be specified for `checkbox` or `radio` type menu items.
*/
checked?: boolean;
/**
@@ -8772,9 +10225,9 @@ declare namespace Electron {
*/
registerAccelerator?: boolean;
/**
- * Should be specified for submenu type menu items. If submenu is specified, the
- * type: 'submenu' can be omitted. If the value is not a then it will be
- * automatically converted to one using Menu.buildFromTemplate.
+ * Should be specified for `submenu` type menu items. If `submenu` is specified,
+ * the `type: 'submenu'` can be omitted. If the value is not a `Menu` then it will
+ * be automatically converted to one using `Menu.buildFromTemplate`.
*/
submenu?: (MenuItemConstructorOptions[]) | (Menu);
/**
@@ -8784,7 +10237,7 @@ declare namespace Electron {
id?: string;
/**
* Inserts this item before the item with the specified label. If the referenced
- * item doesn't exist the item will be inserted at the end of the menu. Also
+ * item doesn't exist the item will be inserted at the end of the menu. Also
* implies that the menu item in question should be placed in the same “group” as
* the item.
*/
@@ -8810,9 +10263,10 @@ declare namespace Electron {
interface MessageBoxOptions {
/**
- * Can be "none", "info", "error", "question" or "warning". On Windows, "question"
- * displays the same icon as "info", unless you set an icon using the "icon"
- * option. On macOS, both "warning" and "error" display the same warning icon.
+ * Can be `"none"`, `"info"`, `"error"`, `"question"` or `"warning"`. On Windows,
+ * `"question"` displays the same icon as `"info"`, unless you set an icon using
+ * the `"icon"` option. On macOS, both `"warning"` and `"error"` display the same
+ * warning icon.
*/
type?: string;
/**
@@ -8842,32 +10296,32 @@ declare namespace Electron {
*/
checkboxLabel?: string;
/**
- * Initial checked state of the checkbox. false by default.
+ * Initial checked state of the checkbox. `false` by default.
*/
checkboxChecked?: boolean;
icon?: NativeImage;
/**
- * The index of the button to be used to cancel the dialog, via the Esc key. By
+ * The index of the button to be used to cancel the dialog, via the `Esc` key. By
* default this is assigned to the first button with "cancel" or "no" as the label.
- * If no such labeled buttons exist and this option is not set, 0 will be used as
+ * If no such labeled buttons exist and this option is not set, `0` will be used as
* the return value.
*/
cancelId?: number;
/**
- * On Windows Electron will try to figure out which one of the buttons are common
+ * On Windows Electron will try to figure out which one of the `buttons` are common
* buttons (like "Cancel" or "Yes"), and show the others as command links in the
* dialog. This can make the dialog appear in the style of modern Windows apps. If
- * you don't like this behavior, you can set noLink to true.
+ * you don't like this behavior, you can set `noLink` to `true`.
*/
noLink?: boolean;
/**
- * Normalize the keyboard access keys across platforms. Default is false. Enabling
- * this assumes & is used in the button labels for the placement of the keyboard
- * shortcut access key and labels will be converted so they work correctly on each
- * platform, & characters are removed on macOS, converted to _ on Linux, and left
- * untouched on Windows. For example, a button label of Vie&w will be converted to
- * Vie_w on Linux and View on macOS and can be selected via Alt-W on Windows and
- * Linux.
+ * Normalize the keyboard access keys across platforms. Default is `false`.
+ * Enabling this assumes `&` is used in the button labels for the placement of the
+ * keyboard shortcut access key and labels will be converted so they work correctly
+ * on each platform, `&` characters are removed on macOS, converted to `_` on
+ * Linux, and left untouched on Windows. For example, a button label of `Vie&w`
+ * will be converted to `Vie_w` on Linux and `View` on macOS and can be selected
+ * via `Alt-W` on Windows and Linux.
*/
normalizeAccessKeys?: boolean;
}
@@ -8878,16 +10332,17 @@ declare namespace Electron {
*/
response: number;
/**
- * The checked state of the checkbox if checkboxLabel was set. Otherwise false.
+ * The checked state of the checkbox if `checkboxLabel` was set. Otherwise `false`.
*/
checkboxChecked: boolean;
}
interface MessageBoxSyncOptions {
/**
- * Can be "none", "info", "error", "question" or "warning". On Windows, "question"
- * displays the same icon as "info", unless you set an icon using the "icon"
- * option. On macOS, both "warning" and "error" display the same warning icon.
+ * Can be `"none"`, `"info"`, `"error"`, `"question"` or `"warning"`. On Windows,
+ * `"question"` displays the same icon as `"info"`, unless you set an icon using
+ * the `"icon"` option. On macOS, both `"warning"` and `"error"` display the same
+ * warning icon.
*/
type?: string;
/**
@@ -8917,32 +10372,32 @@ declare namespace Electron {
*/
checkboxLabel?: string;
/**
- * Initial checked state of the checkbox. false by default.
+ * Initial checked state of the checkbox. `false` by default.
*/
checkboxChecked?: boolean;
icon?: NativeImage;
/**
- * The index of the button to be used to cancel the dialog, via the Esc key. By
+ * The index of the button to be used to cancel the dialog, via the `Esc` key. By
* default this is assigned to the first button with "cancel" or "no" as the label.
- * If no such labeled buttons exist and this option is not set, 0 will be used as
+ * If no such labeled buttons exist and this option is not set, `0` will be used as
* the return value.
*/
cancelId?: number;
/**
- * On Windows Electron will try to figure out which one of the buttons are common
+ * On Windows Electron will try to figure out which one of the `buttons` are common
* buttons (like "Cancel" or "Yes"), and show the others as command links in the
* dialog. This can make the dialog appear in the style of modern Windows apps. If
- * you don't like this behavior, you can set noLink to true.
+ * you don't like this behavior, you can set `noLink` to `true`.
*/
noLink?: boolean;
/**
- * Normalize the keyboard access keys across platforms. Default is false. Enabling
- * this assumes & is used in the button labels for the placement of the keyboard
- * shortcut access key and labels will be converted so they work correctly on each
- * platform, & characters are removed on macOS, converted to _ on Linux, and left
- * untouched on Windows. For example, a button label of Vie&w will be converted to
- * Vie_w on Linux and View on macOS and can be selected via Alt-W on Windows and
- * Linux.
+ * Normalize the keyboard access keys across platforms. Default is `false`.
+ * Enabling this assumes `&` is used in the button labels for the placement of the
+ * keyboard shortcut access key and labels will be converted so they work correctly
+ * on each platform, `&` characters are removed on macOS, converted to `_` on
+ * Linux, and left untouched on Windows. For example, a button label of `Vie&w`
+ * will be converted to `Vie_w` on Linux and `View` on macOS and can be selected
+ * via `Alt-W` on Windows and Linux.
*/
normalizeAccessKeys?: boolean;
}
@@ -8956,7 +10411,7 @@ declare namespace Electron {
*/
disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other');
/**
- * The options which should be used for creating the new .
+ * The options which should be used for creating the new `BrowserWindow`.
*/
options: Options;
}
@@ -8998,7 +10453,7 @@ declare namespace Electron {
sound?: string;
/**
* Actions to add to the notification. Please read the available actions and
- * limitations in the NotificationAction documentation.
+ * limitations in the `NotificationAction` documentation.
*/
actions?: NotificationAction[];
/**
@@ -9008,7 +10463,15 @@ declare namespace Electron {
closeButtonText?: string;
}
- interface OnBeforeRedirectDetails {
+ interface OnBeforeRedirectFilter {
+ /**
+ * Array of URL patterns that will be used to filter out the requests that do not
+ * match the URL patterns.
+ */
+ urls: string[];
+ }
+
+ interface OnBeforeRedirectListenerDetails {
id: number;
url: string;
method: string;
@@ -9026,7 +10489,7 @@ declare namespace Electron {
responseHeaders: ResponseHeaders;
}
- interface OnBeforeRedirectFilter {
+ interface OnBeforeRequestFilter {
/**
* Array of URL patterns that will be used to filter out the requests that do not
* match the URL patterns.
@@ -9034,7 +10497,7 @@ declare namespace Electron {
urls: string[];
}
- interface OnBeforeRequestDetails {
+ interface OnBeforeRequestListenerDetails {
id: number;
url: string;
method: string;
@@ -9045,7 +10508,7 @@ declare namespace Electron {
uploadData: UploadData[];
}
- interface OnBeforeRequestFilter {
+ interface OnBeforeSendHeadersFilter {
/**
* Array of URL patterns that will be used to filter out the requests that do not
* match the URL patterns.
@@ -9053,7 +10516,7 @@ declare namespace Electron {
urls: string[];
}
- interface OnBeforeSendHeadersDetails {
+ interface OnBeforeSendHeadersListenerDetails {
id: number;
url: string;
method: string;
@@ -9064,7 +10527,7 @@ declare namespace Electron {
requestHeaders: RequestHeaders;
}
- interface OnBeforeSendHeadersFilter {
+ interface OnCompletedFilter {
/**
* Array of URL patterns that will be used to filter out the requests that do not
* match the URL patterns.
@@ -9072,15 +10535,7 @@ declare namespace Electron {
urls: string[];
}
- interface OnBeforeSendHeadersResponse {
- cancel?: boolean;
- /**
- * When provided, request will be made with these headers.
- */
- requestHeaders?: RequestHeaders;
- }
-
- interface OnCompletedDetails {
+ interface OnCompletedListenerDetails {
id: number;
url: string;
method: string;
@@ -9094,7 +10549,7 @@ declare namespace Electron {
statusLine: string;
}
- interface OnCompletedFilter {
+ interface OnErrorOccurredFilter {
/**
* Array of URL patterns that will be used to filter out the requests that do not
* match the URL patterns.
@@ -9102,7 +10557,7 @@ declare namespace Electron {
urls: string[];
}
- interface OnErrorOccurredDetails {
+ interface OnErrorOccurredListenerDetails {
id: number;
url: string;
method: string;
@@ -9117,7 +10572,7 @@ declare namespace Electron {
error: string;
}
- interface OnErrorOccurredFilter {
+ interface OnHeadersReceivedFilter {
/**
* Array of URL patterns that will be used to filter out the requests that do not
* match the URL patterns.
@@ -9125,7 +10580,7 @@ declare namespace Electron {
urls: string[];
}
- interface OnHeadersReceivedDetails {
+ interface OnHeadersReceivedListenerDetails {
id: number;
url: string;
method: string;
@@ -9138,7 +10593,7 @@ declare namespace Electron {
responseHeaders: ResponseHeaders;
}
- interface OnHeadersReceivedFilter {
+ interface OnResponseStartedFilter {
/**
* Array of URL patterns that will be used to filter out the requests that do not
* match the URL patterns.
@@ -9146,20 +10601,7 @@ declare namespace Electron {
urls: string[];
}
- interface OnHeadersReceivedResponse {
- cancel?: boolean;
- /**
- * When provided, the server is assumed to have responded with these headers.
- */
- responseHeaders?: ResponseHeaders;
- /**
- * Should be provided when overriding responseHeaders to change header status
- * otherwise original response header's status will be used.
- */
- statusLine?: string;
- }
-
- interface OnResponseStartedDetails {
+ interface OnResponseStartedListenerDetails {
id: number;
url: string;
method: string;
@@ -9176,7 +10618,7 @@ declare namespace Electron {
statusLine: string;
}
- interface OnResponseStartedFilter {
+ interface OnSendHeadersFilter {
/**
* Array of URL patterns that will be used to filter out the requests that do not
* match the URL patterns.
@@ -9184,7 +10626,7 @@ declare namespace Electron {
urls: string[];
}
- interface OnSendHeadersDetails {
+ interface OnSendHeadersListenerDetails {
id: number;
url: string;
method: string;
@@ -9195,24 +10637,16 @@ declare namespace Electron {
requestHeaders: RequestHeaders;
}
- interface OnSendHeadersFilter {
- /**
- * Array of URL patterns that will be used to filter out the requests that do not
- * match the URL patterns.
- */
- urls: string[];
- }
-
interface OpenDevToolsOptions {
/**
- * Opens the devtools with specified dock state, can be right, bottom, undocked,
- * detach. Defaults to last used dock state. In undocked mode it's possible to dock
- * back. In detach mode it's not.
+ * Opens the devtools with specified dock state, can be `right`, `bottom`,
+ * `undocked`, `detach`. Defaults to last used dock state. In `undocked` mode it's
+ * possible to dock back. In `detach` mode it's not.
*/
mode: ('right' | 'bottom' | 'undocked' | 'detach');
/**
* Whether to bring the opened devtools window to the foreground. The default is
- * true.
+ * `true`.
*/
activate?: boolean;
}
@@ -9236,21 +10670,25 @@ declare namespace Electron {
*/
message?: string;
/**
- * Create when packaged for the Mac App Store.
+ * Create security scoped bookmarks when packaged for the Mac App Store.
*/
securityScopedBookmarks?: boolean;
}
interface OpenDialogReturnValue {
+ /**
+ * whether or not the dialog was canceled.
+ */
+ canceled: boolean;
/**
* An array of file paths chosen by the user. If the dialog is cancelled this will
* be an empty array.
*/
filePaths?: string[];
/**
- * An array matching the filePaths array of base64 encoded strings which contains
- * security scoped bookmark data. securityScopedBookmarks must be enabled for this
- * to be populated.
+ * An array matching the `filePaths` array of base64 encoded strings which contains
+ * security scoped bookmark data. `securityScopedBookmarks` must be enabled for
+ * this to be populated.
*/
bookmarks?: string[];
}
@@ -9274,29 +10712,31 @@ declare namespace Electron {
*/
message?: string;
/**
- * Create when packaged for the Mac App Store.
+ * Create security scoped bookmarks when packaged for the Mac App Store.
*/
securityScopedBookmarks?: boolean;
}
interface OpenExternalOptions {
/**
- * true to bring the opened application to the foreground. The default is true.
+ * `true` to bring the opened application to the foreground. The default is `true`.
+ * _macOS_
*/
activate?: boolean;
/**
- * The working directory.
+ * The working directory. _Windows_
*/
workingDirectory?: string;
}
interface OpenExternalSyncOptions {
/**
- * true to bring the opened application to the foreground. The default is true.
+ * `true` to bring the opened application to the foreground. The default is `true`.
+ * _macOS_
*/
activate?: boolean;
/**
- * The working directory.
+ * The working directory. _Windows_
*/
workingDirectory?: string;
}
@@ -9315,7 +10755,7 @@ declare namespace Electron {
interface Parameters {
/**
- * Specify the screen type to emulate (default: desktop):
+ * Specify the screen type to emulate (default: `desktop`):
*/
screenPosition: ('desktop' | 'mobile');
/**
@@ -9323,13 +10763,13 @@ declare namespace Electron {
*/
screenSize: Size;
/**
- * Position the view on the screen (screenPosition == mobile) (default: { x: 0, y:
- * 0 }).
+ * Position the view on the screen (screenPosition == mobile) (default: `{ x: 0, y:
+ * 0 }`).
*/
viewPosition: Point;
/**
* Set the device scale factor (if zero defaults to original device scale factor)
- * (default: 0).
+ * (default: `0`).
*/
deviceScaleFactor: number;
/**
@@ -9338,7 +10778,7 @@ declare namespace Electron {
viewSize: Size;
/**
* Scale of emulated view inside available space (not in fit to view mode)
- * (default: 1).
+ * (default: `1`).
*/
scale: number;
}
@@ -9354,24 +10794,13 @@ declare namespace Electron {
quantity: number;
}
- interface PermissionCheckHandlerDetails {
- /**
- * The security orign of the media check.
- */
- securityOrigin: string;
- /**
- * The type of media access being requested, can be video, audio or unknown
- */
- mediaType: ('video' | 'audio' | 'unknown');
- }
-
- interface PermissionRequestHandlerDetails {
+ interface PermissionRequestHandlerHandlerDetails {
/**
- * The url of the openExternal request.
+ * The url of the `openExternal` request.
*/
externalURL: string;
/**
- * The types of media access being requested, elements can be video or audio
+ * The types of media access being requested, elements can be `video` or `audio`
*/
mediaTypes: Array<'video' | 'audio'>;
}
@@ -9387,11 +10816,13 @@ declare namespace Electron {
*/
window?: BrowserWindow;
/**
- * Default is the current mouse cursor position. Must be declared if y is declared.
+ * Default is the current mouse cursor position. Must be declared if `y` is
+ * declared.
*/
x?: number;
/**
- * Default is the current mouse cursor position. Must be declared if x is declared.
+ * Default is the current mouse cursor position. Must be declared if `x` is
+ * declared.
*/
y?: number;
/**
@@ -9407,15 +10838,15 @@ declare namespace Electron {
interface PrintOptions {
/**
- * Don't ask user for print settings. Default is false.
+ * Don't ask user for print settings. Default is `false`.
*/
silent?: boolean;
/**
- * Also prints the background color and image of the web page. Default is false.
+ * Also prints the background color and image of the web page. Default is `false`.
*/
printBackground?: boolean;
/**
- * Set the printer device name to use. Default is ''.
+ * Set the printer device name to use. Default is `''`.
*/
deviceName?: string;
}
@@ -9427,8 +10858,8 @@ declare namespace Electron {
*/
marginsType?: number;
/**
- * Specify page size of the generated PDF. Can be A3, A4, A5, Legal, Letter,
- * Tabloid or an Object containing height and width in microns.
+ * Specify page size of the generated PDF. Can be `A3`, `A4`, `A5`, `Legal`,
+ * `Letter`, `Tabloid` or an Object containing `height` and `width` in microns.
*/
pageSize?: (string) | (Size);
/**
@@ -9440,7 +10871,7 @@ declare namespace Electron {
*/
printSelectionOnly?: boolean;
/**
- * true for landscape, false for portrait.
+ * `true` for landscape, `false` for portrait.
*/
landscape?: boolean;
}
@@ -9472,17 +10903,28 @@ declare namespace Electron {
corsEnabled?: boolean;
}
+ interface ProcRequest {
+ hostname: string;
+ certificate: Certificate;
+ /**
+ * Verification result from chromium.
+ */
+ verificationResult: string;
+ /**
+ * Error code.
+ */
+ errorCode: number;
+ }
+
interface ProgressBarOptions {
/**
- * Mode for the progress bar. Can be none, normal, indeterminate, error or paused.
+ * Mode for the progress bar. Can be `none`, `normal`, `indeterminate`, `error` or
+ * `paused`.
*/
mode: ('none' | 'normal' | 'indeterminate' | 'error' | 'paused');
}
interface Provider {
- /**
- * .
- */
spellCheck: (words: string[], callback: (misspeltWords: string[]) => void) => void;
}
@@ -9498,43 +10940,6 @@ declare namespace Electron {
uploadData?: UploadData;
}
- interface RegisterBufferProtocolRequest {
- url: string;
- referrer: string;
- method: string;
- uploadData: UploadData[];
- }
-
- interface RegisterFileProtocolRequest {
- url: string;
- referrer: string;
- method: string;
- uploadData: UploadData[];
- }
-
- interface RegisterHttpProtocolRequest {
- url: string;
- headers: Headers;
- referrer: string;
- method: string;
- uploadData: UploadData[];
- }
-
- interface RegisterStreamProtocolRequest {
- url: string;
- headers: Headers;
- referrer: string;
- method: string;
- uploadData: UploadData[];
- }
-
- interface RegisterStringProtocolRequest {
- url: string;
- referrer: string;
- method: string;
- uploadData: UploadData[];
- }
-
interface RelaunchOptions {
args?: string[];
execPath?: string;
@@ -9556,8 +10961,8 @@ declare namespace Electron {
*/
height?: number;
/**
- * The desired quality of the resize image. Possible values are good, better or
- * best. The default is best. These values express a desired quality/speed
+ * The desired quality of the resize image. Possible values are `good`, `better` or
+ * `best`. The default is `best`. These values express a desired quality/speed
* tradeoff. They are translated into an algorithm-specific method that depends on
* the capabilities (CPU, GPU) of the underlying platform. It is possible for all
* three methods to be mapped to the same algorithm on a given platform.
@@ -9621,12 +11026,13 @@ declare namespace Electron {
*/
nameFieldLabel?: string;
/**
- * Show the tags input box, defaults to true.
+ * Show the tags input box, defaults to `true`.
*/
showsTagField?: boolean;
/**
- * Create a when packaged for the Mac App Store. If this option is enabled and the
- * file doesn't already exist a blank file will be created at the chosen path.
+ * Create a security scoped bookmark when packaged for the Mac App Store. If this
+ * option is enabled and the file doesn't already exist a blank file will be
+ * created at the chosen path.
*/
securityScopedBookmarks?: boolean;
}
@@ -9637,31 +11043,31 @@ declare namespace Electron {
*/
canceled: boolean;
/**
- * If the dialog is canceled this will be undefined.
+ * If the dialog is canceled this will be `undefined`.
*/
filePath?: string;
/**
* Base64 encoded string which contains the security scoped bookmark data for the
- * saved file. securityScopedBookmarks must be enabled for this to be present.
+ * saved file. `securityScopedBookmarks` must be enabled for this to be present.
*/
bookmark?: string;
}
interface Settings {
/**
- * true to open the app at login, false to remove the app as a login item. Defaults
- * to false.
+ * `true` to open the app at login, `false` to remove the app as a login item.
+ * Defaults to `false`.
*/
openAtLogin?: boolean;
/**
- * true to open the app as hidden. Defaults to false. The user can edit this
+ * `true` to open the app as hidden. Defaults to `false`. The user can edit this
* setting from the System Preferences so
- * app.getLoginItemSettings().wasOpenedAsHidden should be checked when the app is
- * opened to know the current value. This setting is not available on .
+ * `app.getLoginItemSettings().wasOpenedAsHidden` should be checked when the app is
+ * opened to know the current value. This setting is not available on MAS builds.
*/
openAsHidden?: boolean;
/**
- * The executable to launch at login. Defaults to process.execPath.
+ * The executable to launch at login. Defaults to `process.execPath`.
*/
path?: string;
/**
@@ -9674,12 +11080,12 @@ declare namespace Electron {
interface SourcesOptions {
/**
* An array of Strings that lists the types of desktop sources to be captured,
- * available types are screen and window.
+ * available types are `screen` and `window`.
*/
types: string[];
/**
- * The size that the media source thumbnail should be scaled to. Default is 150 x
- * 150. Set width or height to 0 when you do not need the thumbnails. This will
+ * The size that the media source thumbnail should be scaled to. Default is `150` x
+ * `150`. Set width or height to 0 when you do not need the thumbnails. This will
* save the processing time required for capturing the content of each window and
* screen.
*/
@@ -9738,7 +11144,7 @@ declare namespace Electron {
*/
label?: string;
/**
- * Button background color in hex format, i.e #ABCDEF.
+ * Button background color in hex format, i.e `#ABCDEF`.
*/
backgroundColor?: string;
/**
@@ -9746,7 +11152,7 @@ declare namespace Electron {
*/
icon?: NativeImage;
/**
- * Can be left, right or overlay.
+ * Can be `left`, `right` or `overlay`.
*/
iconPosition?: ('left' | 'right' | 'overlay');
/**
@@ -9761,7 +11167,7 @@ declare namespace Electron {
*/
availableColors?: string[];
/**
- * The selected hex color in the picker, i.e #ABCDEF.
+ * The selected hex color in the picker, i.e `#ABCDEF`.
*/
selectedColor?: string;
/**
@@ -9788,7 +11194,7 @@ declare namespace Electron {
*/
label?: string;
/**
- * Hex color of text, i.e #ABCDEF.
+ * Hex color of text, i.e `#ABCDEF`.
*/
textColor?: string;
}
@@ -9807,8 +11213,8 @@ declare namespace Electron {
*/
items?: TouchBar;
/**
- * true to display a close button on the left of the popover, false to not show it.
- * Default is true.
+ * `true` to display a close button on the left of the popover, `false` to not show
+ * it. Default is `true`.
*/
showCloseButton?: boolean;
}
@@ -9827,23 +11233,23 @@ declare namespace Electron {
*/
highlight: (highlightedIndex: number) => void;
/**
- * Selected item style. Defaults to null.
+ * Selected item style. Defaults to `null`.
*/
selectedStyle: string;
/**
- * Selected overlay item style. Defaults to null.
+ * Selected overlay item style. Defaults to `null`.
*/
overlayStyle: string;
/**
- * Defaults to false.
+ * Defaults to `false`.
*/
showArrowButtons: boolean;
/**
- * Defaults to free.
+ * Defaults to `free`.
*/
mode: string;
/**
- * Defaults to true.
+ * Defaults to `true`.
*/
continuous: boolean;
}
@@ -9902,6 +11308,9 @@ declare namespace Electron {
size?: ('small' | 'large' | 'flexible');
}
+ interface TraceBufferUsageReturnValue {
+ }
+
interface UpdateTargetUrlEvent extends Event {
url: string;
}
@@ -9913,8 +11322,8 @@ declare namespace Electron {
*/
active: boolean;
/**
- * Whether the upload has started. If this is false both current and total will be
- * set to 0.
+ * Whether the upload has started. If this is false both `current` and `total` will
+ * be set to 0.
*/
started: boolean;
/**
@@ -9927,17 +11336,6 @@ declare namespace Electron {
total: number;
}
- interface Versions {
- /**
- * A String representing Chrome's version string.
- */
- chrome?: string;
- /**
- * A String representing Electron's version string.
- */
- electron?: string;
- }
-
interface VisibleOnAllWorkspacesOptions {
/**
* Sets whether the window should be visible above fullscreen windows
@@ -10052,23 +11450,23 @@ declare namespace Electron {
interface WebPreferences {
/**
- * Whether to enable DevTools. If it is set to false, can not use
- * BrowserWindow.webContents.openDevTools() to open DevTools. Default is true.
+ * Whether to enable DevTools. If it is set to `false`, can not use
+ * `BrowserWindow.webContents.openDevTools()` to open DevTools. Default is `true`.
*/
devTools?: boolean;
/**
- * Whether node integration is enabled. Default is false.
+ * Whether node integration is enabled. Default is `false`.
*/
nodeIntegration?: boolean;
/**
- * Whether node integration is enabled in web workers. Default is false. More about
- * this can be found in .
+ * Whether node integration is enabled in web workers. Default is `false`. More
+ * about this can be found in Multithreading.
*/
nodeIntegrationInWorker?: boolean;
/**
* Experimental option for enabling NodeJS support in sub-frames such as iframes.
- * All your preloads will load for every iframe, you can use process.isMainFrame to
- * determine if you are in the main frame or not.
+ * All your preloads will load for every iframe, you can use `process.isMainFrame`
+ * to determine if you are in the main frame or not.
*/
nodeIntegrationInSubFrames?: boolean;
/**
@@ -10076,98 +11474,102 @@ declare namespace Electron {
* This script will always have access to node APIs no matter whether node
* integration is turned on or off. The value should be the absolute file path to
* the script. When node integration is turned off, the preload script can
- * reintroduce Node global symbols back to the global scope. See example . For
- * security reasons, preload scripts can only be loaded from a subpath of the .
+ * reintroduce Node global symbols back to the global scope. See example here.
+ * **Note:** For security reasons, preload scripts can only be loaded from a
+ * subpath of the app path.
*/
preload?: string;
/**
* If set, this will sandbox the renderer associated with the window, making it
* compatible with the Chromium OS-level sandbox and disabling the Node.js engine.
- * This is not the same as the nodeIntegration option and the APIs available to the
- * preload script are more limited. Read more about the option . This option is
- * currently experimental and may change or be removed in future Electron releases.
+ * This is not the same as the `nodeIntegration` option and the APIs available to
+ * the preload script are more limited. Read more about the option here. **Note:**
+ * This option is currently experimental and may change or be removed in future
+ * Electron releases.
*/
sandbox?: boolean;
/**
- * Whether to enable the module. Default is true.
+ * Whether to enable the `remote` module. Default is `true`.
*/
enableRemoteModule?: boolean;
/**
* Sets the session used by the page. Instead of passing the Session object
- * directly, you can also choose to use the partition option instead, which accepts
- * a partition string. When both session and partition are provided, session will
- * be preferred. Default is the default session.
+ * directly, you can also choose to use the `partition` option instead, which
+ * accepts a partition string. When both `session` and `partition` are provided,
+ * `session` will be preferred. Default is the default session.
*/
session?: Session;
/**
* Sets the session used by the page according to the session's partition string.
- * If partition starts with persist:, the page will use a persistent session
- * available to all pages in the app with the same partition. If there is no
- * persist: prefix, the page will use an in-memory session. By assigning the same
- * partition, multiple pages can share the same session. Default is the default
+ * If `partition` starts with `persist:`, the page will use a persistent session
+ * available to all pages in the app with the same `partition`. If there is no
+ * `persist:` prefix, the page will use an in-memory session. By assigning the same
+ * `partition`, multiple pages can share the same session. Default is the default
* session.
*/
partition?: string;
/**
- * When specified, web pages with the same affinity will run in the same renderer
- * process. Note that due to reusing the renderer process, certain webPreferences
+ * When specified, web pages with the same `affinity` will run in the same renderer
+ * process. Note that due to reusing the renderer process, certain `webPreferences`
* options will also be shared between the web pages even when you specified
- * different values for them, including but not limited to preload, sandbox and
- * nodeIntegration. So it is suggested to use exact same webPreferences for web
- * pages with the same affinity.
+ * different values for them, including but not limited to `preload`, `sandbox` and
+ * `nodeIntegration`. So it is suggested to use exact same `webPreferences` for web
+ * pages with the same `affinity`. _This property is experimental_
*/
affinity?: string;
/**
- * The default zoom factor of the page, 3.0 represents 300%. Default is 1.0.
+ * The default zoom factor of the page, `3.0` represents `300%`. Default is `1.0`.
*/
zoomFactor?: number;
/**
- * Enables JavaScript support. Default is true.
+ * Enables JavaScript support. Default is `true`.
*/
javascript?: boolean;
/**
- * When false, it will disable the same-origin policy (usually using testing
- * websites by people), and set allowRunningInsecureContent to true if this options
- * has not been set by user. Default is true.
+ * When `false`, it will disable the same-origin policy (usually using testing
+ * websites by people), and set `allowRunningInsecureContent` to `true` if this
+ * options has not been set by user. Default is `true`.
*/
webSecurity?: boolean;
/**
* Allow an https page to run JavaScript, CSS or plugins from http URLs. Default is
- * false.
+ * `false`.
*/
allowRunningInsecureContent?: boolean;
/**
- * Enables image support. Default is true.
+ * Enables image support. Default is `true`.
*/
images?: boolean;
/**
- * Make TextArea elements resizable. Default is true.
+ * Make TextArea elements resizable. Default is `true`.
*/
textAreasAreResizable?: boolean;
/**
- * Enables WebGL support. Default is true.
+ * Enables WebGL support. Default is `true`.
*/
webgl?: boolean;
/**
- * Whether plugins should be enabled. Default is false.
+ * Whether plugins should be enabled. Default is `false`.
*/
plugins?: boolean;
/**
- * Enables Chromium's experimental features. Default is false.
+ * Enables Chromium's experimental features. Default is `false`.
*/
experimentalFeatures?: boolean;
/**
- * Enables scroll bounce (rubber banding) effect on macOS. Default is false.
+ * Enables scroll bounce (rubber banding) effect on macOS. Default is `false`.
*/
scrollBounce?: boolean;
/**
- * A list of feature strings separated by ,, like CSSVariables,KeyboardEventKey to
- * enable. The full list of supported feature strings can be found in the file.
+ * A list of feature strings separated by `,`, like `CSSVariables,KeyboardEventKey`
+ * to enable. The full list of supported feature strings can be found in the
+ * RuntimeEnabledFeatures.json5 file.
*/
enableBlinkFeatures?: string;
/**
- * A list of feature strings separated by ,, like CSSVariables,KeyboardEventKey to
- * disable. The full list of supported feature strings can be found in the file.
+ * A list of feature strings separated by `,`, like `CSSVariables,KeyboardEventKey`
+ * to disable. The full list of supported feature strings can be found in the
+ * RuntimeEnabledFeatures.json5 file.
*/
disableBlinkFeatures?: string;
/**
@@ -10175,66 +11577,70 @@ declare namespace Electron {
*/
defaultFontFamily?: DefaultFontFamily;
/**
- * Defaults to 16.
+ * Defaults to `16`.
*/
defaultFontSize?: number;
/**
- * Defaults to 13.
+ * Defaults to `13`.
*/
defaultMonospaceFontSize?: number;
/**
- * Defaults to 0.
+ * Defaults to `0`.
*/
minimumFontSize?: number;
/**
- * Defaults to ISO-8859-1.
+ * Defaults to `ISO-8859-1`.
*/
defaultEncoding?: string;
/**
* Whether to throttle animations and timers when the page becomes background. This
- * also affects the . Defaults to true.
+ * also affects the Page Visibility API. Defaults to `true`.
*/
backgroundThrottling?: boolean;
/**
- * Whether to enable offscreen rendering for the browser window. Defaults to false.
- * See the for more details.
+ * Whether to enable offscreen rendering for the browser window. Defaults to
+ * `false`. See the offscreen rendering tutorial for more details.
*/
offscreen?: boolean;
/**
- * Whether to run Electron APIs and the specified preload script in a separate
- * JavaScript context. Defaults to false. The context that the preload script runs
- * in will still have full access to the document and window globals but it will
- * use its own set of JavaScript builtins (Array, Object, JSON, etc.) and will be
- * isolated from any changes made to the global environment by the loaded page. The
- * Electron API will only be available in the preload script and not the loaded
- * page. This option should be used when loading potentially untrusted remote
- * content to ensure the loaded content cannot tamper with the preload script and
- * any Electron APIs being used. This option uses the same technique used by . You
- * can access this context in the dev tools by selecting the 'Electron Isolated
- * Context' entry in the combo box at the top of the Console tab.
+ * Whether to run Electron APIs and the specified `preload` script in a separate
+ * JavaScript context. Defaults to `false`. The context that the `preload` script
+ * runs in will still have full access to the `document` and `window` globals but
+ * it will use its own set of JavaScript builtins (`Array`, `Object`, `JSON`, etc.)
+ * and will be isolated from any changes made to the global environment by the
+ * loaded page. The Electron API will only be available in the `preload` script and
+ * not the loaded page. This option should be used when loading potentially
+ * untrusted remote content to ensure the loaded content cannot tamper with the
+ * `preload` script and any Electron APIs being used. This option uses the same
+ * technique used by Chrome Content Scripts. You can access this context in the dev
+ * tools by selecting the 'Electron Isolated Context' entry in the combo box at the
+ * top of the Console tab.
*/
contextIsolation?: boolean;
/**
- * Whether to use native window.open(). Defaults to false. Child windows will
- * always have node integration disabled. This option is currently experimental.
+ * Whether to use native `window.open()`. Defaults to `false`. Child windows will
+ * always have node integration disabled. **Note:** This option is currently
+ * experimental.
*/
nativeWindowOpen?: boolean;
/**
- * Whether to enable the . Defaults to false. The preload script configured for the
- * will have node integration enabled when it is executed so you should ensure
- * remote/untrusted content is not able to create a tag with a possibly malicious
- * preload script. You can use the will-attach-webview event on to strip away the
- * preload script and to validate or alter the 's initial settings.
+ * Whether to enable the `<webview>` tag. Defaults to `false`. **Note:** The
+ * `preload` script configured for the `<webview>` will have node integration
+ * enabled when it is executed so you should ensure remote/untrusted content is not
+ * able to create a `<webview>` tag with a possibly malicious `preload` script. You
+ * can use the `will-attach-webview` event on webContents to strip away the
+ * `preload` script and to validate or alter the `<webview>`'s initial settings.
*/
webviewTag?: boolean;
/**
- * A list of strings that will be appended to process.argv in the renderer process
- * of this app. Useful for passing small bits of data down to renderer process
- * preload scripts.
+ * A list of strings that will be appended to `process.argv` in the renderer
+ * process of this app. Useful for passing small bits of data down to renderer
+ * process preload scripts.
*/
additionalArguments?: string[];
/**
- * Whether to enable browser style consecutive dialog protection. Default is false.
+ * Whether to enable browser style consecutive dialog protection. Default is
+ * `false`.
*/
safeDialogs?: boolean;
/**
@@ -10245,45 +11651,45 @@ declare namespace Electron {
safeDialogsMessage?: string;
/**
* Whether dragging and dropping a file or link onto the page causes a navigation.
- * Default is false.
+ * Default is `false`.
*/
navigateOnDragDrop?: boolean;
/**
* Autoplay policy to apply to content in the window, can be
- * no-user-gesture-required, user-gesture-required,
- * document-user-activation-required. Defaults to no-user-gesture-required.
+ * `no-user-gesture-required`, `user-gesture-required`,
+ * `document-user-activation-required`. Defaults to `no-user-gesture-required`.
*/
autoplayPolicy?: ('no-user-gesture-required' | 'user-gesture-required' | 'document-user-activation-required');
/**
* Whether to prevent the window from resizing when entering HTML Fullscreen.
- * Default is false.
+ * Default is `false`.
*/
disableHtmlFullscreenWindowResize?: boolean;
}
interface DefaultFontFamily {
/**
- * Defaults to Times New Roman.
+ * Defaults to `Times New Roman`.
*/
standard?: string;
/**
- * Defaults to Times New Roman.
+ * Defaults to `Times New Roman`.
*/
serif?: string;
/**
- * Defaults to Arial.
+ * Defaults to `Arial`.
*/
sansSerif?: string;
/**
- * Defaults to Courier New.
+ * Defaults to `Courier New`.
*/
monospace?: string;
/**
- * Defaults to Script.
+ * Defaults to `Script`.
*/
cursive?: string;
/**
- * Defaults to Impact.
+ * Defaults to `Impact`.
*/
fantasy?: string;
}
@@ -10315,15 +11721,16 @@ interface Document {
}
declare namespace NodeJS {
- interface Process extends EventEmitter {
+ interface Process extends NodeJS.EventEmitter {
// Docs: http://electronjs.org/docs/api/process
/**
* Emitted when Electron has loaded its internal initialization script and is
- * beginning to load the web page or the main script. It can be used by the preload
- * script to add removed Node global symbols back to the global scope when node
- * integration is turned off:
+ * beginning to load the web page or the main script.
+ *
+ * It can be used by the preload script to add removed Node global symbols back to
+ * the global scope when node integration is turned off:
*/
on(event: 'loaded', listener: Function): this;
once(event: 'loaded', listener: Function): this;
@@ -10335,35 +11742,65 @@ declare namespace NodeJS {
crash(): void;
getCPUUsage(): Electron.CPUUsage;
/**
+ * The number of milliseconds since epoch, or `null` if the information is
+ * unavailable
+ *
* Indicates the creation time of the application. The time is represented as
* number of milliseconds since epoch. It returns null if it is unable to get the
* process creation time.
*/
getCreationTime(): (number) | (null);
/**
+ * * `totalHeapSize` Integer
+ * * `totalHeapSizeExecutable` Integer
+ * * `totalPhysicalSize` Integer
+ * * `totalAvailableSize` Integer
+ * * `usedHeapSize` Integer
+ * * `heapSizeLimit` Integer
+ * * `mallocedMemory` Integer
+ * * `peakMallocedMemory` Integer
+ * * `doesZapGarbage` Boolean
+ *
* Returns an object with V8 heap statistics. Note that all statistics are reported
* in Kilobytes.
*/
getHeapStatistics(): Electron.HeapStatistics;
getIOCounters(): Electron.IOCounters;
/**
+ * Resolves with a ProcessMemoryInfo
+ *
* Returns an object giving memory usage statistics about the current process. Note
* that all statistics are reported in Kilobytes. This api should be called after
- * app ready. Chromium does not provide residentSet value for macOS. This is
- * because macOS performs in-memory compression of pages that haven't been recently
- * used. As a result the resident set size value is not what one would expect.
- * private memory is more representative of the actual pre-compression memory usage
- * of the process on macOS.
+ * app ready.
+ *
+ * Chromium does not provide `residentSet` value for macOS. This is because macOS
+ * performs in-memory compression of pages that haven't been recently used. As a
+ * result the resident set size value is not what one would expect. `private`
+ * memory is more representative of the actual pre-compression memory usage of the
+ * process on macOS.
*/
getProcessMemoryInfo(): Promise<Electron.ProcessMemoryInfo>;
/**
+ * * `total` Integer - The total amount of physical memory in Kilobytes available
+ * to the system.
+ * * `free` Integer - The total amount of memory not being used by applications or
+ * disk cache.
+ * * `swapTotal` Integer _Windows_ _Linux_ - The total amount of swap memory in
+ * Kilobytes available to the system.
+ * * `swapFree` Integer _Windows_ _Linux_ - The free amount of swap memory in
+ * Kilobytes available to the system.
+ *
* Returns an object giving memory usage statistics about the entire system. Note
* that all statistics are reported in Kilobytes.
*/
getSystemMemoryInfo(): Electron.SystemMemoryInfo;
/**
- * Examples: Note: It returns the actual operating system version instead of kernel
- * version on macOS unlike os.release().
+ * The version of the host operating system.
+ *
+ * Examples:
+ *
+ * **Note:** It returns the actual operating system version instead of kernel
+ * version on macOS unlike `os.release()`.
*/
getSystemVersion(): string;
/**
@@ -10371,88 +11808,99 @@ declare namespace NodeJS {
*/
hang(): void;
/**
- * Sets the file descriptor soft limit to maxDescriptors or the OS hard limit,
+ * Sets the file descriptor soft limit to `maxDescriptors` or the OS hard limit,
* whichever is lower for the current process.
*/
setFdLimit(maxDescriptors: number): void;
/**
- * Takes a V8 heap snapshot and saves it to filePath.
+ * Indicates whether the snapshot has been created successfully.
+ *
+Takes a V8 heap snapshot and saves it to `filePath`.
*/
takeHeapSnapshot(filePath: string): boolean;
/**
- * A Boolean. When app is started by being passed as parameter to the default app,
- * this property is true in the main process, otherwise it is undefined.
+ * A `String` representing Chrome's version string.
+ */
+ chrome: string;
+ /**
+ * A `Boolean`. When app is started by being passed as parameter to the default
+ * app, this property is `true` in the main process, otherwise it is `undefined`.
+ */
+ defaultApp: boolean;
+ /**
+ * A `String` representing Electron's version string.
*/
- defaultApp?: boolean;
+ electron: string;
/**
- * A Boolean that controls whether or not deprecation warnings are printed to
- * stderr when formerly callback-based APIs converted to Promises are invoked using
- * callbacks. Setting this to true will enable deprecation warnings.
+ * A `Boolean` that controls whether or not deprecation warnings are printed to
+ * `stderr` when formerly callback-based APIs converted to Promises are invoked
+ * using callbacks. Setting this to `true` will enable deprecation warnings.
*/
- enablePromiseAPIs?: boolean;
+ enablePromiseAPIs: boolean;
/**
- * A Boolean, true when the current renderer context is the "main" renderer frame.
- * If you want the ID of the current frame you should use webFrame.routingId.
+ * A `Boolean`, `true` when the current renderer context is the "main" renderer
+ * frame. If you want the ID of the current frame you should use
+ * `webFrame.routingId`.
*/
- isMainFrame?: boolean;
+ isMainFrame: boolean;
/**
- * A Boolean. For Mac App Store build, this property is true, for other builds it
- * is undefined.
+ * A `Boolean`. For Mac App Store build, this property is `true`, for other builds
+ * it is `undefined`.
*/
- mas?: boolean;
+ mas: boolean;
/**
- * A Boolean that controls ASAR support inside your application. Setting this to
- * true will disable the support for asar archives in Node's built-in modules.
+ * A `Boolean` that controls ASAR support inside your application. Setting this to
+ * `true` will disable the support for `asar` archives in Node's built-in modules.
*/
- noAsar?: boolean;
+ noAsar: boolean;
/**
- * A Boolean that controls whether or not deprecation warnings are printed to
- * stderr. Setting this to true will silence deprecation warnings. This property is
- * used instead of the --no-deprecation command line flag.
+ * A `Boolean` that controls whether or not deprecation warnings are printed to
+ * `stderr`. Setting this to `true` will silence deprecation warnings. This
+ * property is used instead of the `--no-deprecation` command line flag.
*/
- noDeprecation?: boolean;
+ noDeprecation: boolean;
/**
- * A String representing the path to the resources directory.
+ * A `String` representing the path to the resources directory.
*/
- resourcesPath?: string;
+ resourcesPath: string;
/**
- * A Boolean. When the renderer process is sandboxed, this property is true,
- * otherwise it is undefined.
+ * A `Boolean`. When the renderer process is sandboxed, this property is `true`,
+ * otherwise it is `undefined`.
*/
- sandboxed?: boolean;
+ sandboxed: boolean;
/**
- * A Boolean that controls whether or not deprecation warnings will be thrown as
- * exceptions. Setting this to true will throw errors for deprecations. This
- * property is used instead of the --throw-deprecation command line flag.
+ * A `Boolean` that controls whether or not deprecation warnings will be thrown as
+ * exceptions. Setting this to `true` will throw errors for deprecations. This
+ * property is used instead of the `--throw-deprecation` command line flag.
*/
- throwDeprecation?: boolean;
+ throwDeprecation: boolean;
/**
- * A Boolean that controls whether or not deprecations printed to stderr include
- * their stack trace. Setting this to true will print stack traces for
- * deprecations. This property is instead of the --trace-deprecation command line
+ * A `Boolean` that controls whether or not deprecations printed to `stderr`
+ * include their stack trace. Setting this to `true` will print stack traces for
+ * deprecations. This property is instead of the `--trace-deprecation` command line
* flag.
*/
- traceDeprecation?: boolean;
+ traceDeprecation: boolean;
/**
- * A Boolean that controls whether or not process warnings printed to stderr
- * include their stack trace. Setting this to true will print stack traces for
+ * A `Boolean` that controls whether or not process warnings printed to `stderr`
+ * include their stack trace. Setting this to `true` will print stack traces for
* process warnings (including deprecations). This property is instead of the
- * --trace-warnings command line flag.
+ * `--trace-warnings` command line flag.
*/
- traceProcessWarnings?: boolean;
+ traceProcessWarnings: boolean;
/**
- * A String representing the current process's type, can be "browser" (i.e. main
- * process), "renderer", or "worker" (i.e. web worker).
+ * A `String` representing the current process's type, can be `"browser"` (i.e.
+ * main process), `"renderer"`, or `"worker"` (i.e. web worker).
*/
- type?: string;
+ type: string;
/**
- * A Boolean. If the app is running as a Windows Store app (appx), this property is
- * true, for otherwise it is undefined.
+ * A `Boolean`. If the app is running as a Windows Store app (appx), this property
+ * is `true`, for otherwise it is `undefined`.
*/
- windowsStore?: boolean;
+ windowsStore: boolean;
}
interface ProcessVersions {
electron: string;
chrome: string;
}
-}
+}
\ No newline at end of file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment