docs: update to the use of arrow functions in line with the style guide (#30194)

* docs: Update to the use of arrow functions in line with the style guide

* docs: Fixed unmatched bracket typo in previous commit 9ebe3e58f7948c6636d77f3c58a2693683b69691

* fix linting

Co-authored-by: Cheng Zhao <zcbenz@gmail.com>
This commit is contained in:
Matthew Shen 2021-08-01 21:57:37 -04:00 коммит произвёл GitHub
Родитель ced2e8779f
Коммит c0e72bd335
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
16 изменённых файлов: 33 добавлений и 33 удалений

Просмотреть файл

@ -21,7 +21,7 @@ In the testing framework Spectron, you can now audit each window and `<webview>`
tag in your application. For example: tag in your application. For example:
```javascript ```javascript
app.client.auditAccessibility().then(function (audit) { app.client.auditAccessibility().then((audit) => {
if (audit.failed) { if (audit.failed) {
console.error(audit.message) console.error(audit.message)
} }

Просмотреть файл

@ -84,11 +84,15 @@ class TestDriver {
In the app, you'd need to write a simple handler for the RPC calls: In the app, you'd need to write a simple handler for the RPC calls:
```js ```js
if (process.env.APP_TEST_DRIVER) { const METHODS = {
process.on('message', onMessage) isReady () {
// do any setup needed
return true
}
// define your RPC-able methods here
} }
async function onMessage ({ msgId, cmd, args }) { const onMessage = async ({ msgId, cmd, args }) => {
let method = METHODS[cmd] let method = METHODS[cmd]
if (!method) method = () => new Error('Invalid method: ' + cmd) if (!method) method = () => new Error('Invalid method: ' + cmd)
try { try {
@ -104,12 +108,8 @@ async function onMessage ({ msgId, cmd, args }) {
} }
} }
const METHODS = { if (process.env.APP_TEST_DRIVER) {
isReady () { process.on('message', onMessage)
// do any setup needed
return true
}
// define your RPC-able methods here
} }
``` ```

Просмотреть файл

@ -138,7 +138,7 @@ Finally, the `main.js` file represents the main process and contains the actual
const { app, BrowserWindow, ipcMain, nativeTheme } = require('electron') const { app, BrowserWindow, ipcMain, nativeTheme } = require('electron')
const path = require('path') const path = require('path')
function createWindow () { const createWindow = () => {
const win = new BrowserWindow({ const win = new BrowserWindow({
width: 800, width: 800,
height: 600, height: 600,

Просмотреть файл

@ -39,7 +39,7 @@ inAppPurchase.on('transactions-updated', (event, transactions) => {
} }
// Check each transaction. // Check each transaction.
transactions.forEach(function (transaction) { transactions.forEach((transaction) => {
const payment = transaction.payment const payment = transaction.payment
switch (transaction.transactionState) { switch (transaction.transactionState) {

Просмотреть файл

@ -82,7 +82,7 @@ listen for the `keyup` and `keydown` [DOM events][dom-events] inside the
renderer process using the [addEventListener() API][addEventListener-api]. renderer process using the [addEventListener() API][addEventListener-api].
```javascript fiddle='docs/fiddles/features/keyboard-shortcuts/web-apis|focus=renderer.js' ```javascript fiddle='docs/fiddles/features/keyboard-shortcuts/web-apis|focus=renderer.js'
function handleKeyPress(event) { const handleKeyPress = (event) => {
// You can put code here to handle the keypress. // You can put code here to handle the keypress.
document.getElementById("last-keypress").innerText = event.key; document.getElementById("last-keypress").innerText = event.key;
console.log(`You pressed ${event.key}`); console.log(`You pressed ${event.key}`);

Просмотреть файл

@ -44,7 +44,7 @@ if (process.defaultApp) {
We will now define the function in charge of creating our browser window and load our application's `index.html` file. We will now define the function in charge of creating our browser window and load our application's `index.html` file.
```js ```js
function createWindow () { const createWindow = () => {
// Create the browser window. // Create the browser window.
mainWindow = new BrowserWindow({ mainWindow = new BrowserWindow({
width: 800, width: 800,
@ -112,7 +112,7 @@ Finally, we will add some additional code to handle when someone closes our appl
// Quit when all windows are closed, except on macOS. There, it's common // Quit when all windows are closed, except on macOS. There, it's common
// for applications and their menu bar to stay active until the user quits // for applications and their menu bar to stay active until the user quits
// explicitly with Cmd + Q. // explicitly with Cmd + Q.
app.on('window-all-closed', function () { app.on('window-all-closed', () => {
if (process.platform !== 'darwin') app.quit() if (process.platform !== 'darwin') app.quit()
}) })
``` ```

Просмотреть файл

@ -25,7 +25,7 @@ Starting with a working application from the
```javascript fiddle='docs/fiddles/features/macos-dock-menu' ```javascript fiddle='docs/fiddles/features/macos-dock-menu'
const { app, BrowserWindow, Menu } = require('electron') const { app, BrowserWindow, Menu } = require('electron')
function createWindow () { const createWindow = () => {
const win = new BrowserWindow({ const win = new BrowserWindow({
width: 800, width: 800,
height: 600, height: 600,

Просмотреть файл

@ -134,7 +134,7 @@ app.whenReady().then(async () => {
<script> <script>
const { ipcRenderer } = require('electron') const { ipcRenderer } = require('electron')
function doWork(input) { const doWork = (input) => {
// Something cpu-intensive. // Something cpu-intensive.
return input * 2 return input * 2
} }
@ -185,7 +185,7 @@ stream of data.
```js ```js
// renderer.js /////////////////////////////////////////////////////////////// // renderer.js ///////////////////////////////////////////////////////////////
function makeStreamingRequest (element, callback) { const makeStreamingRequest = (element, callback) => {
// MessageChannels are lightweight--it's cheap to create a new one for each // MessageChannels are lightweight--it's cheap to create a new one for each
// request. // request.
const { port1, port2 } = new MessageChannel() const { port1, port2 } = new MessageChannel()

Просмотреть файл

@ -54,7 +54,7 @@ const { Notification } = require('electron')
const NOTIFICATION_TITLE = 'Basic Notification' const NOTIFICATION_TITLE = 'Basic Notification'
const NOTIFICATION_BODY = 'Notification from the Main process' const NOTIFICATION_BODY = 'Notification from the Main process'
function showNotification () { const showNotification = () => {
new Notification({ title: NOTIFICATION_TITLE, body: NOTIFICATION_BODY }).show() new Notification({ title: NOTIFICATION_TITLE, body: NOTIFICATION_BODY }).show()
} }

Просмотреть файл

@ -41,7 +41,7 @@ Starting with an HTML file `index.html`, this example will demonstrate how the `
In order to mutate the DOM, create a `renderer.js` file that adds event listeners to the `'online'` and `'offline'` `window` events. The event handler sets the content of the `<strong id='status'>` element depending on the result of `navigator.onLine`. In order to mutate the DOM, create a `renderer.js` file that adds event listeners to the `'online'` and `'offline'` `window` events. The event handler sets the content of the `<strong id='status'>` element depending on the result of `navigator.onLine`.
```js title='renderer.js' ```js title='renderer.js'
function updateOnlineStatus () { const updateOnlineStatus = () => {
document.getElementById('status').innerHTML = navigator.onLine ? 'online' : 'offline' document.getElementById('status').innerHTML = navigator.onLine ? 'online' : 'offline'
} }
@ -56,7 +56,7 @@ Finally, create a `main.js` file for main process that creates the window.
```js title='main.js' ```js title='main.js'
const { app, BrowserWindow } = require('electron') const { app, BrowserWindow } = require('electron')
function createWindow () { const createWindow = () => {
const onlineStatusWindow = new BrowserWindow({ const onlineStatusWindow = new BrowserWindow({
width: 400, width: 400,
height: 100 height: 100

Просмотреть файл

@ -84,7 +84,7 @@ uses `app` APIs to create a more native application window experience.
```js title='main.js' ```js title='main.js'
// quitting the app when no windows are open on macOS // quitting the app when no windows are open on macOS
app.on('window-all-closed', function () { app.on('window-all-closed', () => {
if (process.platform !== 'darwin') app.quit() if (process.platform !== 'darwin') app.quit()
}) })
``` ```

Просмотреть файл

@ -48,7 +48,7 @@ const { app, BrowserWindow } = require('electron')
let progressInterval let progressInterval
function createWindow () { const createWindow = () => {
const win = new BrowserWindow({ const win = new BrowserWindow({
width: 800, width: 800,
height: 600 height: 600

Просмотреть файл

@ -166,7 +166,7 @@ Then, add a `createWindow()` function that loads `index.html` into a new `Browse
instance. instance.
```js ```js
function createWindow () { const createWindow = () => {
const win = new BrowserWindow({ const win = new BrowserWindow({
width: 800, width: 800,
height: 600 height: 600
@ -216,7 +216,7 @@ To implement this, listen for the `app` module's [`'window-all-closed'`][window-
event, and call [`app.quit()`][app-quit] if the user is not on macOS (`darwin`). event, and call [`app.quit()`][app-quit] if the user is not on macOS (`darwin`).
```js ```js
app.on('window-all-closed', function () { app.on('window-all-closed', () => {
if (process.platform !== 'darwin') app.quit() if (process.platform !== 'darwin') app.quit()
}) })
``` ```
@ -244,7 +244,7 @@ from within your existing `whenReady()` callback.
app.whenReady().then(() => { app.whenReady().then(() => {
createWindow() createWindow()
app.on('activate', function () { app.on('activate', () => {
if (BrowserWindow.getAllWindows().length === 0) createWindow() if (BrowserWindow.getAllWindows().length === 0) createWindow()
}) })
}) })
@ -295,7 +295,7 @@ to the `webPreferences.preload` option in your existing `BrowserWindow` construc
const path = require('path') const path = require('path')
// modify your existing createWindow() function // modify your existing createWindow() function
function createWindow () { const createWindow = () => {
const win = new BrowserWindow({ const win = new BrowserWindow({
width: 800, width: 800,
height: 600, height: 600,
@ -360,7 +360,7 @@ The full code is available below:
const { app, BrowserWindow } = require('electron') const { app, BrowserWindow } = require('electron')
const path = require('path') const path = require('path')
function createWindow () { const createWindow = () => {
// Create the browser window. // Create the browser window.
const mainWindow = new BrowserWindow({ const mainWindow = new BrowserWindow({
width: 800, width: 800,
@ -383,7 +383,7 @@ function createWindow () {
app.whenReady().then(() => { app.whenReady().then(() => {
createWindow() createWindow()
app.on('activate', function () { app.on('activate', () => {
// On macOS it's common to re-create a window in the app when the // On macOS it's common to re-create a window in the app when the
// dock icon is clicked and there are no other windows open. // dock icon is clicked and there are no other windows open.
if (BrowserWindow.getAllWindows().length === 0) createWindow() if (BrowserWindow.getAllWindows().length === 0) createWindow()
@ -393,7 +393,7 @@ app.whenReady().then(() => {
// Quit when all windows are closed, except on macOS. There, it's common // Quit when all windows are closed, except on macOS. There, it's common
// for applications and their menu bar to stay active until the user quits // for applications and their menu bar to stay active until the user quits
// explicitly with Cmd + Q. // explicitly with Cmd + Q.
app.on('window-all-closed', function () { app.on('window-all-closed', () => {
if (process.platform !== 'darwin') app.quit() if (process.platform !== 'darwin') app.quit()
}) })

Просмотреть файл

@ -22,7 +22,7 @@ const { app, BrowserWindow } = require('electron')
const fs = require('fs') const fs = require('fs')
const path = require('path') const path = require('path')
function createWindow () { const createWindow = () => {
const win = new BrowserWindow({ const win = new BrowserWindow({
width: 800, width: 800,
height: 600 height: 600

Просмотреть файл

@ -24,7 +24,7 @@ To set the represented file of window, you can use the
const { app, BrowserWindow } = require('electron') const { app, BrowserWindow } = require('electron')
const os = require('os'); const os = require('os');
function createWindow () { const createWindow = () => {
const win = new BrowserWindow({ const win = new BrowserWindow({
width: 800, width: 800,
height: 600 height: 600

Просмотреть файл

@ -216,7 +216,7 @@ access to a `window.readConfig()` method, but no Node.js features.
```js ```js
const { readFileSync } = require('fs') const { readFileSync } = require('fs')
window.readConfig = function () { window.readConfig = () => {
const data = readFileSync('./config.json') const data = readFileSync('./config.json')
return data return data
} }