Main 进程 API 参考文档

全局变量

global 下挂载了三个全局变量：

1. isDev，用于判断是否是开发模式
2. __static，指向 static 静态资源目录
3. __resource，指向 resource 外部资源目录

Application

引入方法: 无需引入，Application 自动注入到 Manager 中。

• plugins: 插件列表，包含内置插件（即各种内置的 Manager）和外部加载的插件。

• emitOneManager: 触发某个 manager 的监听事件

• emitOneManagerSerial: 触发某个 manager 的监听事件，并按序执行

• emitAllManager: 触发所有 manager 的某个监听事件

• emitAllManagerSerial: 触发所有 manager 的某个监听事件，并按序执行

注意： 触发事件的方法都是按内部存储的 manager 信息来依次触发各个 manager 的事件的，当一个 manager 对某个事件添加了多个处理函数时，非 Serial 函数会同时触发并等待所有处理函数完成，而 Serial 函数会依次等待处理函数完成

BaseManager

引入方法:

import BaseManager from '@gui/main/core/base-manager';

所有 Manager 的继承父类，是一个继承了 Emittery.Typed 的 abstract 类，自身没有提供任何 API。

Storage

引入方法: 无需引入，Application 自动注入到 Manager 中。

Storage 类继承自 electron-store，除指定类型外没有做其他修改，具体 API 请参考相关文档。

WorkspaceWindow

引入方法: 无需引入，Application 自动注入到 Manager 中。

WorkspaceWindow 用于控制 Renderer 进程窗口的开启的信息发送

• open: 打开 Renderer 进程窗口

• send: (channel: string, ...args: any[]) => void，向当前窗口发送一个信道信息，若窗口未被打开，则不会发送消息。

Utils

• setIpcReplier: (channel: string, handler: (...args: any[]) => any): () => void

引入方法:

import { setIpcReplier } from '@gui/main/utils';

对应 ipcSend 的 Main 进程端处理函数的设置函数，该处理函数的正常返回值会被 ipcSend 当做成功响应 resolve，若处理函数中 throw 了一个 Error，ipcSend 则会 reject 这个 error 的 message.

注意：ipcSend 和 setIpcReplier 必须一一对应，不允许 setIpcReplier 对同一个 channel 信道设置多个处理函数。

Events

事件的命名规则一般为：manager名称[.特殊标识]:事件名称