事件类 API

事件类 API 遵循以 onXxxXxx, beforeXxx, afterXxx 的命名规范,接收一个参数为回调函数。

beforeDevServer

dev server 启动之前。

afterDevServer

dev server 启动之后。

onStart

umi dev 或者 umi build 开始时触发。

onDevCompileDone

umi dev 编译完成后触发。

  1. api.onDevCompileDone(({ isFirstCompile, stats }) => {
  2. });

onOptionChange

插件的配置改变的时候触发。

  1. export default (api, defaultOpts = { immer: false }) => {
  2. let opts = defaultOpts;
  3. api.onOptionChange((newOpts) => {
  4. opts = newOpts;
  5. api.rebuildFiles();
  6. });
  7. };

onBuildSuccess

umi build 成功时候。主要做一些构建产物的处理。

  1. api.onBuildSuccess(({ stats }) => {
  2. // handle with stats
  3. });

onBuildFail

umi build 失败的时候。

onHTMLRebuild

当 HTML 重新构建时被触发。

onGenerateFiles

路由文件,入口文件生成时被触发。

onPatchRoute

获取单个路由的配置时触发,可以在这里修改路由配置 route。比如可以向 Routes 中添加组件路径使得可以给路由添加一层封装。

  1. api.onPatchRoute({ route } => {
  2. // route:
  3. // {
  4. // path: '/xxx',
  5. // Routes: []
  6. // }
  7. })