github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-01-09 15:38:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

chore: update links in comments (#37197)

Browse Source
This commit is contained in:
David Sanders
2023-02-11 18:52:54 -08:00
committed by GitHub
parent 3180312595
commit a37f572388
9 changed files with 45 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
spec/ts-smoke/electron/main.ts
View File

@@ -30,7 +30,7 @@ import {
import * as path from 'path'
// Quick start
// https://github.com/electron/electron/blob/master/docs/tutorial/quick-start.md
// https://github.com/electron/electron/blob/main/docs/tutorial/quick-start.md
// Keep a global reference of the window object, if you don't, the window will
// be closed automatically when the javascript object is GCed.
@@ -318,7 +318,7 @@ app.setAboutPanelOptions({
})
// Online/Offline Event Detection
// https://github.com/electron/electron/blob/master/docs/tutorial/online-offline-events.md
// https://github.com/electron/electron/blob/main/docs/tutorial/online-offline-events.md
let onlineStatusWindow: Electron.BrowserWindow
@@ -333,7 +333,7 @@ ipcMain.on('online-status-changed', (event: any, status: any) => {
})
// Synopsis
// https://github.com/electron/electron/blob/master/docs/api/synopsis.md
// https://github.com/electron/electron/blob/main/docs/api/synopsis.md
app.whenReady().then(() => {
window = new BrowserWindow({
@@ -345,14 +345,14 @@ app.whenReady().then(() => {
})
// Supported command line switches
// https://github.com/electron/electron/blob/master/docs/api/command-line-switches.md
// https://github.com/electron/electron/blob/main/docs/api/command-line-switches.md
app.commandLine.appendSwitch('remote-debugging-port', '8315')
app.commandLine.appendSwitch('host-rules', 'MAP * 127.0.0.1')
app.commandLine.appendSwitch('vmodule', 'console=0')
// systemPreferences
// https://github.com/electron/electron/blob/master/docs/api/system-preferences.md
// https://github.com/electron/electron/blob/main/docs/api/system-preferences.md
const browserOptions = {
width: 1000,
@@ -391,7 +391,7 @@ if (browserOptions.transparent) {
}
// app
// https://github.com/electron/electron/blob/master/docs/api/app.md
// https://github.com/electron/electron/blob/main/docs/api/app.md
app.on('certificate-error', function (event, webContents, url, error, certificate, callback) {
if (url === 'https://github.com') {
@@ -422,7 +422,7 @@ app.relaunch({ args: process.argv.slice(1).concat(['--relaunch']) })
app.exit(0)
// auto-updater
// https://github.com/electron/electron/blob/master/docs/api/auto-updater.md
// https://github.com/electron/electron/blob/main/docs/api/auto-updater.md
autoUpdater.setFeedURL({
url: 'http://mycompany.com/myapp/latest?version=' + app.getVersion(),
@@ -443,7 +443,7 @@ autoUpdater.on('update-downloaded', (event, releaseNotes, releaseName, releaseDa
})
// BrowserWindow
// https://github.com/electron/electron/blob/master/docs/api/browser-window.md
// https://github.com/electron/electron/blob/main/docs/api/browser-window.md
let win3 = new BrowserWindow({ width: 800, height: 600, show: false })
win3.on('closed', () => {
@@ -469,7 +469,7 @@ window.setVibrancy('popover')
window.setIcon('/path/to/icon')
// content-tracing
// https://github.com/electron/electron/blob/master/docs/api/content-tracing.md
// https://github.com/electron/electron/blob/main/docs/api/content-tracing.md
const options = {
categoryFilter: '*',
@@ -486,7 +486,7 @@ contentTracing.startRecording(options).then(() => {
})
// dialog
// https://github.com/electron/electron/blob/master/docs/api/dialog.md
// https://github.com/electron/electron/blob/main/docs/api/dialog.md
// variant without browserWindow
dialog.showOpenDialogSync({
@@ -507,7 +507,7 @@ dialog.showOpenDialog(win3, {
})
// global-shortcut
// https://github.com/electron/electron/blob/master/docs/api/global-shortcut.md
// https://github.com/electron/electron/blob/main/docs/api/global-shortcut.md
// Register a 'ctrl+x' shortcut listener.
const ret = globalShortcut.register('ctrl+x', () => {
@@ -525,7 +525,7 @@ globalShortcut.unregister('ctrl+x')
globalShortcut.unregisterAll()
// ipcMain
// https://github.com/electron/electron/blob/master/docs/api/ipc-main-process.md
// https://github.com/electron/electron/blob/main/docs/api/ipc-main.md
ipcMain.on('asynchronous-message', (event, arg: any) => {
console.log(arg) // prints "ping"
@@ -551,7 +551,7 @@ const winWindows = new BrowserWindow({
})
// menu-item
// https://github.com/electron/electron/blob/master/docs/api/menu-item.md
// https://github.com/electron/electron/blob/main/docs/api/menu-item.md
const menuItem = new MenuItem({})
@@ -561,7 +561,7 @@ menuItem.click = (passedMenuItem: Electron.MenuItem, browserWindow: Electron.Bro
}
// menu
// https://github.com/electron/electron/blob/master/docs/api/menu.md
// https://github.com/electron/electron/blob/main/docs/api/menu.md
let menu = new Menu()
menu.append(new MenuItem({ label: 'MenuItem1', click: () => { console.log('item 1 clicked') } }))
@@ -809,7 +809,7 @@ Menu.buildFromTemplate([
])
// net
// https://github.com/electron/electron/blob/master/docs/api/net.md
// https://github.com/electron/electron/blob/main/docs/api/net.md
app.whenReady().then(() => {
const request = net.request('https://github.com')
@@ -854,7 +854,7 @@ app.whenReady().then(() => {
})
// power-monitor
// https://github.com/electron/electron/blob/master/docs/api/power-monitor.md
// https://github.com/electron/electron/blob/main/docs/api/power-monitor.md
app.whenReady().then(() => {
powerMonitor.on('suspend', () => {
@@ -872,7 +872,7 @@ app.whenReady().then(() => {
})
// power-save-blocker
// https://github.com/electron/electron/blob/master/docs/api/power-save-blocker.md
// https://github.com/electron/electron/blob/main/docs/api/power-save-blocker.md
const id = powerSaveBlocker.start('prevent-display-sleep')
console.log(powerSaveBlocker.isStarted(id))
@@ -880,7 +880,7 @@ console.log(powerSaveBlocker.isStarted(id))
powerSaveBlocker.stop(id)
// protocol
// https://github.com/electron/electron/blob/master/docs/api/protocol.md
// https://github.com/electron/electron/blob/main/docs/api/protocol.md
app.whenReady().then(() => {
protocol.registerSchemesAsPrivileged([{ scheme: 'https', privileges: { standard: true, allowServiceWorkers: true } }])
@@ -907,7 +907,7 @@ app.whenReady().then(() => {
})
// tray
// https://github.com/electron/electron/blob/master/docs/api/tray.md
// https://github.com/electron/electron/blob/main/docs/api/tray.md
let appIcon: Electron.Tray = null
app.whenReady().then(() => {
@@ -950,7 +950,7 @@ app.whenReady().then(() => {
})
// clipboard
// https://github.com/electron/electron/blob/master/docs/api/clipboard.md
// https://github.com/electron/electron/blob/main/docs/api/clipboard.md
{
let str: string
@@ -973,7 +973,7 @@ app.whenReady().then(() => {
}
// crash-reporter
// https://github.com/electron/electron/blob/master/docs/api/crash-reporter.md
// https://github.com/electron/electron/blob/main/docs/api/crash-reporter.md
crashReporter.start({
productName: 'YourName',
@@ -989,7 +989,7 @@ console.log(crashReporter.getLastCrashReport())
console.log(crashReporter.getUploadedReports())
// nativeImage
// https://github.com/electron/electron/blob/master/docs/api/native-image.md
// https://github.com/electron/electron/blob/main/docs/api/native-image.md
const appIcon2 = new Tray('/Users/somebody/images/icon.png')
const window2 = new BrowserWindow({ icon: '/Users/somebody/images/window.png' })
@@ -1000,7 +1000,7 @@ const appIcon4 = new Tray('/Users/somebody/images/icon.png')
const image2 = nativeImage.createFromPath('/Users/somebody/images/icon.png')
// process
// https://github.com/electron/electron/blob/master/docs/api/process.md
// https://github.com/electron/electron/blob/main/docs/api/process.md
console.log(process.versions.electron)
console.log(process.versions.chrome)
@@ -1014,7 +1014,7 @@ process.hang()
process.setFdLimit(8192)
// screen
// https://github.com/electron/electron/blob/master/docs/api/screen.md
// https://github.com/electron/electron/blob/main/docs/api/screen.md
app.whenReady().then(() => {
const size = screen.getPrimaryDisplay().workAreaSize
@@ -1052,7 +1052,7 @@ app.whenReady().then(() => {
})
// shell
// https://github.com/electron/electron/blob/master/docs/api/shell.md
// https://github.com/electron/electron/blob/main/docs/api/shell.md
shell.showItemInFolder('/home/user/Desktop/test.txt')
shell.trashItem('/home/user/Desktop/test.txt').then(() => {})
@@ -1070,7 +1070,7 @@ shell.beep()
shell.writeShortcutLink('/home/user/Desktop/shortcut.lnk', 'update', shell.readShortcutLink('/home/user/Desktop/shortcut.lnk'))
// cookies
// https://github.com/electron/electron/blob/master/docs/api/cookies.md
// https://github.com/electron/electron/blob/main/docs/api/cookies.md
{
// Query all cookies.
session.defaultSession.cookies.get({})
@@ -1100,7 +1100,7 @@ shell.writeShortcutLink('/home/user/Desktop/shortcut.lnk', 'update', shell.readS
}
// session
// https://github.com/electron/electron/blob/master/docs/api/session.md
// https://github.com/electron/electron/blob/main/docs/api/session.md
session.defaultSession.on('will-download', (event, item, webContents) => {
event.preventDefault()
@@ -1197,7 +1197,7 @@ app.whenReady().then(function () {
})
// webContents
// https://github.com/electron/electron/blob/master/docs/api/web-contents.md
// https://github.com/electron/electron/blob/main/docs/api/web-contents.md
console.log(webContents.getAllWebContents())
console.log(webContents.getFocusedWebContents())

20
spec/ts-smoke/electron/renderer.ts
View File

@@ -11,7 +11,7 @@ import {
import * as fs from 'fs'
// In renderer process (web page).
// https://github.com/electron/electron/blob/master/docs/api/ipc-renderer.md
// https://github.com/electron/electron/blob/main/docs/api/ipc-renderer.md
console.log(ipcRenderer.sendSync('synchronous-message', 'ping')) // prints "pong"
ipcRenderer.on('asynchronous-reply', (event, arg: any) => {
@@ -22,7 +22,7 @@ ipcRenderer.on('asynchronous-reply', (event, arg: any) => {
ipcRenderer.send('asynchronous-message', 'ping')
// web-frame
// https://github.com/electron/electron/blob/master/docs/api/web-frame.md
// https://github.com/electron/electron/blob/main/docs/api/web-frame.md
webFrame.setZoomFactor(2)
console.log(webFrame.getZoomFactor())
@@ -53,7 +53,7 @@ console.log(webFrame.getResourceUsage())
webFrame.clearCache()
// clipboard
// https://github.com/electron/electron/blob/master/docs/api/clipboard.md
// https://github.com/electron/electron/blob/main/docs/api/clipboard.md
clipboard.writeText('Example String')
clipboard.writeText('Example String', 'selection')
@@ -69,7 +69,7 @@ clipboard.write({
})
// crash-reporter
// https://github.com/electron/electron/blob/master/docs/api/crash-reporter.md
// https://github.com/electron/electron/blob/main/docs/api/crash-reporter.md
crashReporter.start({
productName: 'YourName',
@@ -79,7 +79,7 @@ crashReporter.start({
})
// desktopCapturer
// https://github.com/electron/electron/blob/master/docs/api/desktop-capturer.md
// https://github.com/electron/electron/blob/main/docs/api/desktop-capturer.md
desktopCapturer.getSources({ types: ['window', 'screen'] }).then(sources => {
for (let i = 0; i < sources.length; ++i) {
@@ -111,7 +111,7 @@ function getUserMediaError (error: Error) {
}
// File object
// https://github.com/electron/electron/blob/master/docs/api/file-object.md
// https://github.com/electron/electron/blob/main/docs/api/file-object.md
/*
<div id="holder">
@@ -137,11 +137,11 @@ holder.ondrop = function (e) {
}
// nativeImage
// https://github.com/electron/electron/blob/master/docs/api/native-image.md
// https://github.com/electron/electron/blob/main/docs/api/native-image.md
const image = clipboard.readImage()
// https://github.com/electron/electron/blob/master/docs/api/process.md
// https://github.com/electron/electron/blob/main/docs/api/process.md
// preload.js
const _setImmediate = setImmediate
@@ -152,12 +152,12 @@ process.once('loaded', function () {
})
// shell
// https://github.com/electron/electron/blob/master/docs/api/shell.md
// https://github.com/electron/electron/blob/main/docs/api/shell.md
shell.openExternal('https://github.com').then(() => {})
// <webview>
// https://github.com/electron/electron/blob/master/docs/api/web-view-tag.md
// https://github.com/electron/electron/blob/main/docs/api/webview-tag.md
const webview = document.createElement('webview')
webview.loadURL('https://github.com')