electron 使用yarn electron api_ci

  1. 主进程api
    1.1 Electron app 模块:app 模块是为了控制整个应用的生命周期设计的。
    1.2 Electron autoUpdater 模块:这个模块提供了一个到 Squirrel 自动更新框架的接口。
    1.3 Electron BrowserWindow 模块:BrowserWindow 类让你有创建一个浏览器窗口的权力。
    1.4 Electron contentTracing 模块:content-tracing 模块是用来收集由底层的Chromium content 模块 产生的搜索数据,这个模块不具备web接口。
    1.5 Electron dialog 模块:dialog 模块提供了api来展示原生的系统对话框,例如打开文件框,alert框,所以web应用可以给用户带来跟系统应用相同的体验。
    1.6 Electron global-shortcut 模块:global-shortcut 模块可以便捷的为您设置(注册/注销)各种自定义操作的快捷键。
    1.7 Electron ipcMain 模块:ipcMain 模块是类 EventEmitter 的实例。当在主进程中使用它的时候,它控制着由渲染进程(web page)发送过来的异步或同步消息。从渲染进程发送过来的消息将触发事件。
    1.8 Electron menu 模块:menu 类可以用来创建原生菜单,它可用作应用菜单和 context 菜单。这个模块是一个主进程的模块,并且可以通过 remote 模块给渲染进程调用。每个菜单有一个或几个菜单项 menu items,并且每个菜单项可以有子菜单。
    1.9 Electron MenuItem 模块:菜单项模块允许你向应用或menu添加选项。
    1.10 Electron powerMonitor 模块:power-monitor模块是用来监听能源区改变的.只能在主进程中使用。在 app 模块的 ready 事件触发之后就不能使用这个模块了。
    1.11 Electron powerSaveBlocker 模块:powerSaveBlocker 模块是用来阻止应用系统进入睡眠模式的,因此这允许应用保持系统和屏幕继续工作。
    1.12 Electron protocol 模块:protocol 模块可以注册一个自定义协议,或者使用一个已经存在的协议。
    1.13 Electron session 模块:session 模块可以用来创建一个新的 Session 对象。你也可以通过使用 webContents 的属性 session 来使用一个已有页面的 session ,webContents是BrowserWindow 的属性。
    1.14 Electron webContents 模块:webContents 是一个 事件发出者。它负责渲染并控制网页,也是 BrowserWindow 对象的属性。
    1.15 Electron Tray 模块:用一个 Tray 来表示一个图标,这个图标处于正在运行的系统的通知区 ,通常被添加到一个 context menu 上。
    1.16 Electron Locales:app.getLocale() 返回的区域设置值。
  2. 渲染进程api
    2.1 Electron desktopCapturer 模块:desktopCapturer 模块可用来获取可用资源,这个资源可通过 getUserMedia 捕获得到。
    2.2 Electron ipcRenderer 模块:ipcRenderer 模块是一个 EventEmitter 类的实例。它提供了有限的方法,可以从渲染进程向主进程发送同步或异步消息。也可以收到主进程的响应。
    2.3 Electron remote 模块:remote 模块提供了一种在渲染进程(网页)和主进程之间进行进程间通讯(IPC)的简便途径。Electron中, 与GUI相关的模块(如 dialog, menu 等)只存在于主进程,而不在渲染进程中 。为了能从渲染进程中使用它们,需要用ipc模块来给主进程发送进程间消息。使用 remote 模块,可以调用主进程对象的方法,而无需显式地发送进程间消息,这类似于 Java 的 RMI。
    2.4 Electron webFrame 模块:web-frame 模块允许你自定义如何渲染当前网页。
  3. 两种进程都可用的api
    3.1 Electron clipboard 模块:clipboard 模块提供方法来供复制和粘贴操作。
    3.2 Electron crashReporter 模块:crash-reporter 模块开启发送应用崩溃报告。
    3.3 Electron nativeImage 模块:在 Electron 中, 对所有创建 images 的 api 来说,可以使用文件路径或 nativeImage 实例。如果使用 null ,将创建一个空的image 对象。
    3.4 Electron screen 模块:screen 模块检索屏幕的 size,显示,鼠标位置等的信息。在 app 模块的ready 事件触发之前不可使用这个模块。screen 是一个 EventEmitter。
    3.5 Electron shell 模块:shell 模块提供了集成其他桌面客户端的关联功能。