Class JModule

constructor

• new JModule(__namedParameters): JModule

• Parameters

  • __namedParameters: ModuleOptions

  Returns JModule

  Example

  new JModule({
      key: 'pipeline',
      url: 'http://localhost:8080/modules/pipeline/index.json',
  });
  Copy

Optional activate

Optional autoBootstrap

Optional bootstrap

Optional deactivate

hooks

await module.hooks.complete
Copy

key

metadata

Optional name

resource

Optional type

url

Static define

JModule.define('pipeline', {
    init(module) {
        console.log(module); 
    },
    imports: [],
    exports: {},
});
Copy

Static id

status

• get status(): ModuleStatus

• 获取模块状态

  Returns ModuleStatus
• set status(status): void

• 设置模块状态, 更新后会自动触发 module.${this.key}.statusChange事件

  Parameters

  • status: ModuleStatus

  Returns void

  Fires

  window#module.[moduleKey].statusChange

  Fires

  window#module.[moduleKey].[status]

Static debug

• get debug(): boolean

• Returns boolean

• set debug(status): void

• 设置debug模式，开启后将打印模块注册、加载、解析的全过程信息

  Parameters

  • status: boolean

  Returns void

  Example

  JModule.debug = true;
  Copy

Static registeredModules

• get registeredModules(): JModule[]

• 获取已注册的模块列表

  Returns JModule[]

  Read Only

load

• load(targetStatus?, options?): Promise<void | Resource>

• 加载模块

  Parameters

  • Optional targetStatus: "init" | "preload" | "load" = 'load'

    期望达到的目标状态，默认为 'load'，向下兼容。

  • Optional options: LoadOptions<HTMLScriptElement | HTMLLinkElement> = ...

    选项参数。

  Returns Promise<void | Resource>

  • 返回一个承诺，该承诺在模块加载完成时解决。

  Async

  Method

Static applyResource

• applyResource(resourceMetadata, resourceLoaderUrl?): Resource

• 根据 resourceLoaderUrl 设置资源 当 resourceLoaderUrl 为空时, 该函数只能在 resource.url 文件对应的脚本中执行

  Parameters

  • resourceMetadata: ResourceMetadata

    资源元数据

  • Optional resourceLoaderUrl: string

    加载资源的初始脚本地址, 默认为执行当前函数的脚本文件

  Returns Resource

Static defineType

• defineType(type, typeHandler): void

• 定义子应用类型的处理逻辑

  Parameters

  • type: string

    子应用类型

  • typeHandler: TypeHandler

    类型处理函数

  Returns void

Static export

• export(obj?, matcher?): typeof JModule

• 暴露平台功能给模块使用

  Parameters

  • obj: {} = {}

    需要暴露的对象

  • matcher: {} = {}

  Returns typeof JModule

  Example

  JModule.export({
      $platform: {
          utils, event, router,
      },
      $node_modules: {
          vue: Vue,
      },
  });
  import Vue from '$node_modules.vue';
  Copy

Static getModule

• getModule(key): undefined | JModule

• 根据 moduleKey 获取模块实例

  Parameters

  • key: string

    moduleKey

  Returns undefined | JModule

  Static

Static getModuleAsync

• getModuleAsync(key, timeout?): Promise<JModule>

• 根据 moduleKey 异步获取模块实例

  Parameters

  • key: string

    moduleKey

  • Optional timeout: number

  Returns Promise<JModule>

  Static

Static registerModules

• registerModules(moduleOptions?): Promise<JModule[]>

• 注册模块

  Parameters

  • moduleOptions: ModuleOptions[] = []

  Returns Promise<JModule[]>

  Fires

  window#module.afterRegister

  Example

  JModule.registerModules([{
      type: 'page',
      key: 'pipeline',
      name: 'pipeline',
      url: 'http://localhost:8080/modules/pipeline/index.json',
  }]);
  window.addEventListener('module.afterRegister', ({ detail:modules }) => {
      // do sth;
  })
  Copy

Static require

• require(namespace): Promise<any>

• 引用其它模块暴露的功能

  Parameters

  • namespace: string

  Returns Promise<any>

  Example

  JModule.require('pipeline.models.PipelineApp')
      .then((PipelineApp) => {
          // do something
      });
  Copy