electron 8.0.0-beta.6 → 8.0.0

package/electron.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Electron 8.0.0-beta.6
+// Type definitions for Electron 8.0.0
 // Project: http://electronjs.org/
 // Definitions by: The Electron Team <https://github.com/electron/electron>
 // Definitions: https://github.com/electron/electron-typescript-definitions
@@ -1208,6 +1208,12 @@ This method can only be called before app is ready.
      * 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.
+     *
+     * If you do not set `credits` but still wish to surface them in your app, AppKit
+     * will look for a file named "Credits.html", "Credits.rtf", and "Credits.rtfd", in
+     * that order, in the bundle returned by the NSBundle class method main. The first
+     * file found is used, and if none is found, the info area is left blank. See Apple
+     * documentation for more information.
      */
     setAboutPanelOptions(options: AboutPanelOptionsOptions): void;
     /**
@@ -3883,7 +3889,7 @@ Send given command to the debugging target.
      * * `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.
+     * populated. (For return values, see table here.)
      *
      * The `browserWindow` argument allows the dialog to attach itself to a parent
      * window, making it modal.
@@ -3909,7 +3915,7 @@ Send given command to the debugging target.
      * * `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.
+     * populated. (For return values, see table here.)
      *
      * The `browserWindow` argument allows the dialog to attach itself to a parent
      * window, making it modal.
@@ -3972,7 +3978,8 @@ Send given command to the debugging target.
      * `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.
+     * `securityScopedBookmarks` must be enabled for this to be present. (For return
+     * values, see table here.)
      *
      * The `browserWindow` argument allows the dialog to attach itself to a parent
      * window, making it modal.
@@ -3992,7 +3999,8 @@ Send given command to the debugging target.
      * `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.
+     * `securityScopedBookmarks` must be enabled for this to be present. (For return
+     * values, see table here.)
      *
      * The `browserWindow` argument allows the dialog to attach itself to a parent
      * window, making it modal.
@@ -6323,6 +6331,13 @@ e.g.
     removeListener(event: 'will-download', listener: (event: Event,
                                           item: DownloadItem,
                                           webContents: WebContents) => void): this;
+    /**
+     * Whether the word was successfully written to the custom dictionary.
+     *
+     * **Note:** On macOS and Windows 10 this word will be written to the OS custom
+     * dictionary as well
+     */
+    addWordToSpellCheckerDictionary(word: string): boolean;
     /**
      * Dynamically sets whether to always send credentials for HTTP NTLM or Negotiate
      * authentication.
@@ -6394,6 +6409,9 @@ Clears the host resolver cache.
      * empty the spellchecker will fallback to using `en-US`.  By default on launch if
      * this setting is an empty list Electron will try to populate this setting with
      * the current OS locale.  This setting is persisted across restarts.
+     *
+     * **Note:** On macOS the OS spellchecker is used and has it's own list of
+     * languages.  This API is a no-op on macOS.
      */
     getSpellCheckerLanguages(): string[];
     /**
@@ -6502,6 +6520,9 @@ Clears the host resolver cache.
      * dictionary downloader at your own hosted version of the hunspell dictionaries.
      * We publish a `hunspell_dictionaries.zip` file with each release which contains
      * the files you need to host here.
+     *
+     * **Note:** On macOS the OS spellchecker is used and therefore we do not download
+     * any dictionary files.  This API is a no-op on macOS.
      */
     setSpellCheckerDictionaryDownloadURL(url: string): void;
     /**
@@ -6509,6 +6530,9 @@ Clears the host resolver cache.
      * typing in.  In order for the spell checker to correctly check their words you
      * must call this API with an array of language codes.  You can get the list of
      * supported language codes with the `ses.availableSpellCheckerLanguages` property.
+     *
+     * **Note:** On macOS the OS spellchecker is used and will detect your language
+     * automatically.  This API is a no-op on macOS.
      */
     setSpellCheckerLanguages(languages: string[]): void;
     /**
@@ -9105,6 +9129,13 @@ Calling `event.preventDefault()` will prevent the navigation.
      * Executes the editing command `cut` in web page.
      */
     cut(): void;
+    /**
+     * Decrease the capturer count by one. The page will be set to hidden or occluded
+     * state when its browser window is hidden or occluded and the capturer count
+     * reaches zero. If you want to decrease the hidden capturer count instead you
+     * should set `stayHidden` to true.
+     */
+    decrementCapturerCount(stayHidden?: boolean): void;
     /**
      * Executes the editing command `delete` in web page.
      */
@@ -9232,6 +9263,14 @@ Works like `executeJavaScript` but evaluates `scripts` in an isolated context.
      * Navigates to the specified offset from the "current entry".
      */
     goToOffset(offset: number): void;
+    /**
+     * Increase the capturer count by one. The page is considered visible when its
+     * browser window is hidden and the capturer count is non-zero. If you would like
+     * the page to stay hidden, you should ensure that `stayHidden` is set to true.
+     * 
+This also affects the Page Visibility API.
+     */
+    incrementCapturerCount(size?: Size, stayHidden?: boolean): void;
     /**
      * A promise that resolves with a key for the inserted CSS that can later be used
      * to remove the CSS via `contents.removeInsertedCSS(key)`.
@@ -9273,6 +9312,11 @@ Works like `executeJavaScript` but evaluates `scripts` in an isolated context.
 **Deprecated**
      */
     isAudioMuted(): boolean;
+    /**
+     * Whether this page is being captured. It returns true when the capturer count is
+     * large then 0.
+     */
+    isBeingCaptured(): boolean;
     /**
      * Whether the renderer process has crashed.
      */
@@ -10864,6 +10908,11 @@ See webContents.sendInputEvent for detailed description of `event` object.
      * The style of window title bar. Default is `default`. Possible values are:
      */
     titleBarStyle?: ('default' | 'hidden' | 'hiddenInset' | 'customButtonsOnHover');
+    /**
+     * Set a custom position for the traffic light buttons. Can only be used with
+     * `titleBarStyle` set to `hidden`
+     */
+    trafficLightPosition?: Point;
     /**
      * Shows the title in the title bar in full screen mode on macOS for all
      * `titleBarStyle` options. Default is `false`.
@@ -12152,7 +12201,7 @@ See webContents.sendInputEvent for detailed description of `event` object.
     /**
      * 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.
+     * this to be populated. (For return values, see table here.)
      *
      * @platform darwin,mas
      */
@@ -12516,6 +12565,7 @@ See webContents.sendInputEvent for detailed description of `event` object.
     /**
      * Base64 encoded string which contains the security scoped bookmark data for the
      * saved file. `securityScopedBookmarks` must be enabled for this to be present.
+     * (For return values, see table here.)
      *
      * @platform darwin,mas
      */
@@ -12902,7 +12952,8 @@ See webContents.sendInputEvent for detailed description of `event` object.
      */
     printBackground?: boolean;
     /**
-     * Set the printer device name to use. Default is `''`.
+     * Set the printer device name to use. Must be the system-defined name and not the
+     * 'friendly' name, e.g 'Brother_QL_820NWB' and not 'Brother QL-820NWB'.
      */
     deviceName?: string;
     /**
@@ -13121,9 +13172,7 @@ See webContents.sendInputEvent for detailed description of `event` object.
      * 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 here. **Note:**
-     * This option is currently experimental and may change or be removed in future
-     * Electron releases.
+     * the preload script are more limited. Read more about the option here.
      */
     sandbox?: boolean;
     /**

package/package.json

@@ -16,7 +16,7 @@
     "node": ">= 8.6"
   },
   "name": "electron",
-  "version": "8.0.0-beta.6",
+  "version": "8.0.0",
   "repository": "https://github.com/electron/electron",
   "description": "Build cross platform desktop apps with JavaScript, HTML, and CSS",
   "license": "MIT",