electron 4.0.0-nightly.20181010 → 4.0.0

package/cli.js

@@ -4,7 +4,7 @@ var electron = require('./')
 
 var proc = require('child_process')
 
-var child = proc.spawn(electron, process.argv.slice(2), { stdio: 'inherit' })
+var child = proc.spawn(electron, process.argv.slice(2), { stdio: 'inherit', windowsHide: false })
 child.on('close', function (code) {
   process.exit(code)
 })

package/electron.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Electron 4.0.0-nightly.20181010
+// Type definitions for Electron 4.0.0
 // Project: http://electronjs.org/
 // Definitions by: The Electron Team <https://github.com/electron/electron>
 // Definitions: https://github.com/electron/electron-typescript-definitions
@@ -472,6 +472,40 @@ declare namespace Electron {
     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.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,
+                                              globalName: string) => void): this;
+    once(event: 'remote-get-global', listener: (event: Event,
+                                              webContents: WebContents,
+                                              globalName: string) => void): this;
+    addListener(event: 'remote-get-global', listener: (event: Event,
+                                              webContents: WebContents,
+                                              globalName: string) => void): this;
+    removeListener(event: 'remote-get-global', listener: (event: Event,
+                                              webContents: WebContents,
+                                              globalName: string) => 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.
+     */
+    on(event: 'remote-require', listener: (event: Event,
+                                           webContents: WebContents,
+                                           moduleName: string) => void): this;
+    once(event: 'remote-require', listener: (event: Event,
+                                           webContents: WebContents,
+                                           moduleName: string) => void): this;
+    addListener(event: 'remote-require', listener: (event: Event,
+                                           webContents: WebContents,
+                                           moduleName: string) => void): this;
+    removeListener(event: 'remote-require', listener: (event: Event,
+                                           webContents: WebContents,
+                                           moduleName: string) => 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
@@ -545,14 +579,10 @@ declare namespace Electron {
     /**
      * Emitted when Electron has created a new session.
      */
-    on(event: 'session-created', listener: (event: Event,
-                                            session: Session) => void): this;
-    once(event: 'session-created', listener: (event: Event,
-                                            session: Session) => void): this;
-    addListener(event: 'session-created', listener: (event: Event,
-                                            session: Session) => void): this;
-    removeListener(event: 'session-created', listener: (event: Event,
-                                            session: Session) => void): this;
+    on(event: 'session-created', listener: (session: Session) => void): this;
+    once(event: 'session-created', listener: (session: Session) => void): this;
+    addListener(event: 'session-created', listener: (session: Session) => void): this;
+    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()
@@ -946,6 +976,11 @@ declare namespace Electron {
      * them.
      */
     show(): void;
+    /**
+     * Show the about panel with the values defined in the app's .plist file or with
+     * the options set via app.setAboutPanelOptions(options).
+     */
+    showAboutPanel(): void;
     /**
      * Start accessing a security scoped resource. With this method Electron
      * applications that are packaged for the Mac App Store may reach outside their
@@ -1674,7 +1709,8 @@ declare namespace Electron {
      */
     setBackgroundColor(backgroundColor: string): void;
     /**
-     * Resizes and moves the window to the supplied bounds
+     * Resizes and moves the window to the supplied bounds. Any properties that are not
+     * supplied will default to their current values.
      */
     setBounds(bounds: Rectangle, animate?: boolean): void;
     setBrowserView(browserView: BrowserView): void;
@@ -3181,9 +3217,9 @@ declare namespace Electron {
      */
     sendSync(channel: string, ...args: any[]): any;
     /**
-     * Sends a message to a window with windowid via channel.
+     * Sends a message to a window with webContentsId via channel.
      */
-    sendTo(windowId: number, channel: string, ...args: any[]): void;
+    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.
@@ -4388,6 +4424,17 @@ declare namespace Electron {
                                                            * used, `false` otherwise.
                                                            */
                                                           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
+     * 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.
+     */
+    askForMediaAccess(mediaType: 'microphone' | 'camera'): Promise<Boolean>;
     getAccentColor(): string;
     /**
      * Gets the macOS appearance setting that you have declared you want for your
@@ -4407,6 +4454,11 @@ declare namespace Electron {
      * packager option to true.  See the Electron Packager API for more details.
      */
     getEffectiveAppearance(): ('dark' | 'light' | '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.
+     */
+    getMediaAccessStatus(mediaType: string): ('not-determined' | 'granted' | 'denied' | 'restricted' | 'unknown');
     /**
      * Some popular key and types are:
      */
@@ -4457,7 +4509,7 @@ declare namespace Electron {
      * 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): void;
+    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
@@ -4466,7 +4518,7 @@ declare namespace Electron {
      * unsubscribe the event. Under the hood this API subscribes to
      * NSDistributedNotificationCenter, example values of event are:
      */
-    subscribeNotification(event: string, callback: (event: string, userInfo: any) => void): void;
+    subscribeNotification(event: string, callback: (event: string, userInfo: any) => void): number;
     /**
      * Same as subscribeNotification, but uses
      * NSWorkspace.sharedWorkspace.notificationCenter. This is necessary for events
@@ -5803,6 +5855,32 @@ declare namespace Electron {
     removeListener(event: 'plugin-crashed', listener: (event: Event,
                                            name: string,
                                            version: string) => 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.
+     */
+    on(event: 'remote-get-global', listener: (event: Event,
+                                              globalName: string) => void): this;
+    once(event: 'remote-get-global', listener: (event: Event,
+                                              globalName: string) => void): this;
+    addListener(event: 'remote-get-global', listener: (event: Event,
+                                              globalName: string) => void): this;
+    removeListener(event: 'remote-get-global', listener: (event: Event,
+                                              globalName: string) => 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.
+     */
+    on(event: 'remote-require', listener: (event: Event,
+                                           moduleName: string) => void): this;
+    once(event: 'remote-require', listener: (event: Event,
+                                           moduleName: string) => void): this;
+    addListener(event: 'remote-require', listener: (event: Event,
+                                           moduleName: string) => void): this;
+    removeListener(event: 'remote-require', listener: (event: Event,
+                                           moduleName: string) => void): this;
     /**
      * Emitted when the unresponsive web page becomes responsive again.
      */
@@ -6236,6 +6314,11 @@ declare namespace Electron {
      * Mute the audio on the current web page.
      */
     setAudioMuted(muted: boolean): void;
+    /**
+     * Controls whether or not this WebContents will throttle animations and timers
+     * when the page becomes backgrounded. This also affects the Page Visibility API.
+     */
+    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
@@ -6801,6 +6884,10 @@ declare namespace Electron {
     getTitle(): string;
     getURL(): string;
     getUserAgent(): string;
+    /**
+     * It depends on the remote module, it is therefore not available when this module
+     * is disabled.
+     */
     getWebContents(): WebContents;
     /**
      * Sends a request to get current zoom factor, the callback will be called with
@@ -6992,6 +7079,11 @@ declare namespace Electron {
      * RuntimeEnabledFeatures.json5 file.
      */
     enableblinkfeatures?: string;
+    /**
+     * When this attribute is false the guest page in webview will not have access to
+     * the remote module. The remote module is avaiable by default.
+     */
+    enableremotemodule?: string;
     /**
      * Sets the referrer URL for the guest page.
      */
@@ -7926,6 +8018,7 @@ declare namespace Electron {
 
   interface InterceptHttpProtocolRequest {
     url: string;
+    headers: Headers;
     referrer: string;
     method: string;
     uploadData: UploadData[];
@@ -8091,6 +8184,11 @@ declare namespace Electron {
      * Should only be specified for checkbox or radio type menu items.
      */
     checked?: boolean;
+    /**
+     * If false, the accelerator won't be registered with the system, but it will still
+     * be displayed. Defaults to true.
+     */
+    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
@@ -8435,7 +8533,11 @@ declare namespace Electron {
     /**
      * true to bring the opened application to the foreground. The default is true.
      */
-    activate: boolean;
+    activate?: boolean;
+    /**
+     * The working directory.
+     */
+    workingDirectory?: string;
   }
 
   interface PageFaviconUpdatedEvent extends Event {
@@ -8567,7 +8669,7 @@ declare namespace Electron {
      * 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;
+    pageSize?: (string) | (Size);
     /**
      * Whether to print CSS backgrounds.
      */
@@ -8624,6 +8726,7 @@ declare namespace Electron {
 
   interface RegisterHttpProtocolRequest {
     url: string;
+    headers: Headers;
     referrer: string;
     method: string;
     uploadData: UploadData[];
@@ -8779,7 +8882,7 @@ declare namespace Electron {
     /**
      * true to open the app as hidden. Defaults to false. The user can edit this
      * setting from the System Preferences so
-     * app.getLoginItemStatus().wasOpenedAsHidden should be checked when the app is
+     * app.getLoginItemSettings().wasOpenedAsHidden should be checked when the app is
      * opened to know the current value. This setting is not available on .
      */
     openAsHidden?: boolean;
@@ -9206,6 +9309,10 @@ declare namespace Electron {
      * currently experimental and may change or be removed in future Electron releases.
      */
     sandbox?: boolean;
+    /**
+     * Whether to enable the 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
@@ -9329,12 +9436,13 @@ declare namespace Electron {
      * 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. This option is
-     * currently experimental and may change or be removed in future Electron releases.
+     * Context' entry in the combo box at the top of the Console tab.
      */
     contextIsolation?: boolean;
     /**
-     * Whether to use native window.open(). Defaults to false. This option is currently
+     * Whether to use native window.open(). If set to true, the webPreferences of child
+     * window will always be the same with parent window, regardless of the parameters
+     * passed to window.open(). Defaults to false. This option is currently
      * experimental.
      */
     nativeWindowOpen?: boolean;

package/package.json

@@ -27,7 +27,7 @@
     "node": ">= 4.0"
   },
   "name": "electron",
-  "version": "4.0.0-nightly.20181010",
+  "version": "4.0.0",
   "repository": "https://github.com/electron/electron",
   "description": "Build cross platform desktop apps with JavaScript, HTML, and CSS",
   "license": "MIT",