javascript - 如何创建可配置的 Aurelia 插件？

Question

我正在创建一个基于 Aurelia Skeleton Plugin 的新插件.但我不知道如何使其可配置。我希望用户在添加我的插件时设置一个属性(特别是 API 路径)。因此，无论何时他们使用该插件，它都会按照他们的需要进行配置。

Answer 1

1. 向您的插件 configure 方法添加第二个“回调”参数:

configure(frameworkConfig, callback) {

1. 检查这个参数是否被传入。如果是，用你的“Configurer”类调用它。

const myPluginConfiguration = new MyPluginConfiguration();
if (callback instanceof Function) {
    callback(myPluginConfiguration);
}

1. 最后，应用配置:

myPluginConfiguration.apply();

---

使用你的插件的应用程序会在他们的 main.js 中做这样的事情

...
.plugin('my-plugin', config => config.apiPath('https://api.foo.com/'))
...

---

你的插件的配置类可能看起来像这样:

export class MyPluginConfiguration {
  apiPath(path) {
    // do something with path
  }

  apply() {
    // any final configuration...
  }
}

这是一个官方示例:https://github.com/aurelia/validation/blob/master/src/aurelia-validation.ts#L53