electron/docs/api/promisification.md

Promisification

The Electron team is currently undergoing an initiative to convert callback-based functions in Electron to return Promises. During this transition period, both the callback and Promise-based versions of these functions will work correctly, and will both be documented.

To enable deprecation warnings for these updated functions, use the process.enablePromiseAPI runtime flag.

When a majority of affected functions are migrated, this flag will be enabled by default and all developers will be able to see these deprecation warnings. At that time, the callback-based versions will also be removed from documentation. This document will be continuously updated as more functions are converted.

Candidate Functions

• app.importCertificate(options, callback)
• request.write(chunk[, encoding][, callback])
• request.end([chunk][, encoding][, callback])
• contentTracing.getCategories(callback)
• contentTracing.startRecording(options, callback)
• contentTracing.stopRecording(resultFilePath, callback)
• contentTracing.startMonitoring(options, callback)
• contentTracing.stopMonitoring(callback)
• contentTracing.captureMonitoringSnapshot(resultFilePath, callback)
• contentTracing.getTraceBufferUsage(callback)
• cookies.get(filter, callback)
• cookies.set(details, callback)
• cookies.remove(url, name, callback)
• cookies.flushStore(callback)
• debugger.sendCommand(method[, commandParams, callback])
• dialog.showOpenDialog([browserWindow, ]options[, callback])
• dialog.showSaveDialog([browserWindow, ]options[, callback])
• dialog.showMessageBox([browserWindow, ]options[, callback])
• dialog.showCertificateTrustDialog([browserWindow, ]options, callback)
• inAppPurchase.purchaseProduct(productID, quantity, callback)
• inAppPurchase.getProducts(productIDs, callback)
• netLog.stopLogging([callback])
• protocol.isProtocolHandled(scheme, callback)
• ses.getCacheSize(callback)
• ses.clearCache(callback)
• ses.clearStorageData([options, callback])
• ses.setProxy(config, callback)
• ses.resolveProxy(url, callback)
• ses.clearHostResolverCache([callback])
• ses.getBlobData(identifier, callback)
• ses.clearAuthCache(options[, callback])
• contents.executeJavaScript(code[, userGesture, callback])
• contents.hasServiceWorker(callback)
• contents.unregisterServiceWorker(callback)
• contents.print([options], [callback])
• contents.printToPDF(options, callback)
• contents.savePage(fullPath, saveType, callback)
• webFrame.executeJavaScript(code[, userGesture, callback])
• webFrame.executeJavaScriptInIsolatedWorld(worldId, scripts[, userGesture, callback])
• webviewTag.executeJavaScript(code[, userGesture, callback])
• webviewTag.printToPDF(options, callback)

Converted Functions

• win.capturePage([rect, ]callback)
• webviewTag.capturePage([rect, ]callback)
• contents.capturePage([rect, ]callback)
• app.getFileIcon(path[, options], callback)
• shell.openExternal(url[, options, callback])
• protocol.isProtocolHandled(scheme, callback)
• desktopCapturer.getSources(options, callback)