插件接口简介

umi 的所有插件接口都是通过初始化插件时候的 api 来提供的。分为如下几类:

  • 环境变量,插件中可以使用的一些环境变量
  • 系统级变量,一些插件系统暴露出来的变量或者常量
  • 工具类 API,常用的一些工具类方法
  • 系统级 API,一些插件系统暴露的核心方法
  • 事件类 API,一些插件系统提供的关键的事件点
  • 应用类 API,用于实现插件功能需求的 API,有直接调用和函数回调两种方法

注: 所有的 API 都是通过 api.[theApiName] 的方法使用的,内部的 API 会统一加上 _ 的前缀。

下面是一个基本的使用示例:

  1. export default (api, opts) => {
  2. api.onOptionChange(() => {
  3. api.rebuildTmpFiles();
  4. });
  5. }