document process(es) for all APIs
authorZeke Sikelianos <zeke@sikelianos.com>
Thu, 3 Nov 2016 17:26:00 +0000 (10:26 -0700)
committerZeke Sikelianos <zeke@sikelianos.com>
Thu, 3 Nov 2016 17:26:00 +0000 (10:26 -0700)
26 files changed:
docs/api/auto-updater.md
docs/api/browser-window.md
docs/api/clipboard.md
docs/api/crash-reporter.md
docs/api/dialog.md
docs/api/download-item.md
docs/api/file-object.md
docs/api/global-shortcut.md
docs/api/ipc-main.md
docs/api/ipc-renderer.md
docs/api/menu-item.md
docs/api/menu.md
docs/api/native-image.md
docs/api/net.md
docs/api/power-monitor.md
docs/api/power-save-blocker.md
docs/api/process.md
docs/api/protocol.md
docs/api/remote.md
docs/api/screen.md
docs/api/session.md
docs/api/shell.md
docs/api/system-preferences.md
docs/api/tray.md
docs/api/web-contents.md
docs/api/web-frame.md

index b36dc2042b6dad673de66d9d4eaea07999472f4b..f50dcd091783e446ec062e945aa6a928df9255b2 100644 (file)
@@ -2,6 +2,8 @@
 
 > Enable apps to automatically update themselves.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 The `autoUpdater` module provides an interface for the
 [Squirrel](https://github.com/Squirrel) framework.
 
index f04434ece428b2d31149f72638a1f5be68b30fba..5904e485d986e5228d1ae9423ddbf1ae35bf2cf0 100644 (file)
@@ -2,6 +2,8 @@
 
 > Create and control browser windows.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 ```javascript
 // In the main process.
 const {BrowserWindow} = require('electron')
index 03872ab597a8392b2c8284b2914b7dff30517976..f6e72b82c7ef8d2a4cfedccf3f3f832734511026 100644 (file)
@@ -2,7 +2,7 @@
 
 > Perform copy and paste operations on the system clipboard.
 
-Processes: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process)
+Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process)
 
 The following example shows how to write a string to the clipboard:
 
index 20ee2c26ac6442bb74c9d87671cb7d0820429bb9..b23f8b070b72185405b8282752a27d3b057a433d 100644 (file)
@@ -2,6 +2,8 @@
 
 > Submit crash reports to a remote server.
 
+Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process)
+
 The following is an example of automatically submitting a crash report to a
 remote server:
 
index 1bc971164c0a8644ccb811bafd7822404fc65666..5094c714c38cb743e795ac837a2b1796a2b10f85 100644 (file)
@@ -2,6 +2,8 @@
 
 > Display native system dialogs for opening and saving files, alerting, etc.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 An example of showing a dialog to select multiple files and directories:
 
 ```javascript
index bdb0f8eedf274d75730bd693d206d80727e83d44..08939c344532856d08bb15b7f50ab016f8789751 100644 (file)
@@ -2,6 +2,8 @@
 
 > Control file downloads from remote sources.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 `DownloadItem` is an `EventEmitter` that represents a download item in Electron.
 It is used in `will-download` event of `Session` class, and allows users to
 control the download item.
@@ -59,7 +61,7 @@ Returns:
 * `state` String
 
 Emitted when the download is in a terminal state. This includes a completed
-download, a cancelled download(via `downloadItem.cancel()`), and interrupted
+download, a cancelled download (via `downloadItem.cancel()`), and interrupted
 download that can't be resumed.
 
 The `state` can be one of following:
index c39a0cf715e69331d3889b96a00c7879fc1fe28d..d451513c02fb1c34fa770e00539b1dd9e58d39fa 100644 (file)
@@ -7,7 +7,7 @@ let users work on native files directly with the HTML5 file API. Electron has
 added a `path` attribute to the `File` interface which exposes the file's real
 path on filesystem.
 
-Example on getting a real path from a dragged-onto-the-app file:
+Example of getting a real path from a dragged-onto-the-app file:
 
 ```html
 <div id="holder">
index eb4edda73c2aa0f406a056c45bd97ccaf785860d..db6253e4b747dccc34d30fb5d024d864cf2a1405 100644 (file)
@@ -2,6 +2,8 @@
 
 > Detect keyboard events when the application does not have keyboard focus.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 The `globalShortcut` module can register/unregister a global keyboard shortcut
 with the operating system so that you can customize the operations for various
 shortcuts.
index 9e39d789a9c9a64fb76268119d8e0b7705188482..39ec5140f1781d6521341725ebcf9bfdf995fab9 100644 (file)
@@ -2,6 +2,8 @@
 
 > Communicate asynchronously from the main process to renderer processes.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 The `ipcMain` module is an instance of the
 [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) class. When used in the main
 process, it handles asynchronous and synchronous messages sent from a renderer
index cf4c75133b7deee8fb3e78c48d508b3854a5744c..bdcea83e1e57fda3f20183de061f30d475f11697 100644 (file)
@@ -2,6 +2,8 @@
 
 > Communicate asynchronously from a renderer process to the main process.
 
+Process: [Renderer](../tutorial/quick-start.md#renderer-process)
+
 The `ipcRenderer` module is an instance of the
 [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) class. It provides a few
 methods so you can send synchronous and asynchronous messages from the render
index 5adcdd75ad2e3ffd34eb197c213bbc3b398c719f..812a50f30167a3d2ecb89ddf24815ac9d6866c4d 100644 (file)
@@ -2,6 +2,8 @@
 
 > Add items to native application menus and context menus.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 See [`Menu`](menu.md) for examples.
 
 ## Class: MenuItem
index f3ab77588cbcd4a90f54dd6cb6bdbf305becf527..d5446f46cecd24504f8319f773edcbbb09d612df 100644 (file)
@@ -2,6 +2,8 @@
 
 > Create native application menus and context menus.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 Each `Menu` consists of multiple [`MenuItem`](menu-item.md)s and each `MenuItem`
 can have a submenu.
 
index 4c447d50ec0b76197a6181e51aa98326fc34abe2..67cf4b108ea2232ad4cf38462f1f062ff958b6e8 100644 (file)
@@ -2,6 +2,8 @@
 
 > Create tray, dock, and application icons using PNG or JPG files.
 
+Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process)
+
 In Electron, for the APIs that take images, you can pass either file paths or
 `NativeImage` instances. An empty image will be used when `null` is passed.
 
index e78cddbbd826a2fd8c8225806bb5cfa358417add..6a6a9b1c370475628ed1019b7f4f5e3e07a6fd90 100644 (file)
@@ -2,6 +2,8 @@
 
 > Issue HTTP/HTTPS requests using Chromium's native networking library
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 The `net` module is a client-side API for issuing HTTP(S) requests. It is
 similar to the [HTTP](https://nodejs.org/api/http.html) and
 [HTTPS](https://nodejs.org/api/https.html) modules of Node.js but uses
index d6bbe1041e6bb36a7f9c644b55895fc0640b6341..5827ef62050955bec1cf13ae541ae4794522a298 100644 (file)
@@ -2,6 +2,8 @@
 
 > Monitor power state changes.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 You cannot require or use this module until the `ready` event of the `app`
 module is emitted.
 
index 1164f93fb9a39bab597b497a644b801b30a1ad75..cd1138f19523710df1c063774ab68d66dc41f76b 100644 (file)
@@ -2,6 +2,8 @@
 
 > Block the system from entering low-power (sleep) mode.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 For example:
 
 ```javascript
index 3fe90fc06d3380d23d35bd2d12965d0902531d33..275d05c53eec34cb708cd7959631e4decd0a66e2 100644 (file)
@@ -2,6 +2,8 @@
 
 > Extensions to process object.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 The `process` object is extended in Electron with following APIs:
 
 ## Events
index 4050ea110facda921402224a68c5722c4c33d257..da5604b1fe7cd00471cb7ec84d3f9b2fdecccbef 100644 (file)
@@ -2,6 +2,8 @@
 
 > Register a custom protocol and intercept existing protocol requests.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 An example of implementing a protocol that has the same effect as the
 `file://` protocol:
 
index 08e86bc1926fc2adaa055198331d64b162b34d83..bff7f8ab77eb2824bbaa1a5a351ae1cd64bde65d 100644 (file)
@@ -2,6 +2,8 @@
 
 > Use main process modules from the renderer process.
 
+Process: [Renderer](../tutorial/quick-start.md#renderer-process)
+
 The `remote` module provides a simple way to do inter-process communication
 (IPC) between the renderer process (web page) and the main process.
 
index f366cddf2402700f6cac56c2b12ab87db2a2e92b..53ca76b2022592a4af3a71d65b1869f93eb92e5b 100644 (file)
@@ -2,6 +2,9 @@
 
 > Retrieve information about screen size, displays, cursor position, etc.
 
+Process: [Main](../tutorial/quick-start.md#main-process),
+[Renderer](../tutorial/quick-start.md#renderer-process)
+
 You cannot require or use this module until the `ready` event of the `app`
 module is emitted.
 
index 9cd629fe1d8c3e3f6291d8e585e1084362e61444..849e8bbb64d34ba982dd56e242fb8a93e8584012 100644 (file)
@@ -2,6 +2,8 @@
 
 > Manage browser sessions, cookies, cache, proxy settings, etc.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 The `session` module can be used to create new `Session` objects.
 
 You can also access the `session` of existing pages by using the `session`
index 03f6972e3b88470d249cc860bfdc5e4d7a736b2e..e5fad8659c3cd7bbcdb73dbe9ee10533b4b09177 100644 (file)
@@ -2,6 +2,9 @@
 
 > Manage files and URLs using their default applications.
 
+Process: [Main](../tutorial/quick-start.md#main-process),
+[Renderer](../tutorial/quick-start.md#renderer-process)
+
 The `shell` module provides functions related to desktop integration.
 
 An example of opening a URL in the user's default browser:
index 90fef8fec3b3c442abb2e02c2fac77cb0f97ae7c..535ae403ef0627e1b3e1bb3112cbfd0f5a2edd41 100644 (file)
@@ -2,6 +2,8 @@
 
 > Get system preferences.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 ```javascript
 const {systemPreferences} = require('electron')
 console.log(systemPreferences.isDarkMode())
index 3ac2d54038f4affcfde16240efca025d4c6071f0..6353c470df8c4f1feaece8da972c3809c8822cac 100644 (file)
@@ -2,6 +2,8 @@
 
 > Add icons and context menus to the system's notification area.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 ```javascript
 const {app, Menu, Tray} = require('electron')
 
index 96e3eee7df4d55606f74d28813b0893b6fd8c40f..61bd21f20703d96ddc0945e6656f958c506e55f8 100644 (file)
@@ -2,6 +2,8 @@
 
 > Render and control web pages.
 
+Process: [Main](../tutorial/quick-start.md#main-process)
+
 `webContents` is an
 [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter).
 It is responsible for rendering and controlling a web page and is a property of
index 078ced9725aaf415010ad0bdad8c38d92f355109..f35ea3eed38627231c47276569b6219601d7beef 100644 (file)
@@ -2,6 +2,8 @@
 
 > Customize the rendering of the current web page.
 
+Process: [Renderer](../tutorial/quick-start.md#renderer-process)
+
 An example of zooming current page to 200%.
 
 ```javascript