Constructor
new Module(name)
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | 指定模块名称。 |
Classes
Members
(protected) defaultRetrospect :number
默认回溯时长，默认值：30个自然天。
Type:
- number
(protected) dependencies :Array.<string>
模块的外部依赖。
Type:
- Array.<string>
(protected) deps :Array.<string>
依赖库列表。
Type:
- Array.<string>
(protected) kernel :Kernel
内核对象。
Type:
(protected) name :string
模块名称。
Type:
- string
(protected) pipeline :Pipeline
模块使用的默认数据管道。
Type:
(protected) pluginSystem :PluginSystem
消息插件系统。
Type:
(protected) started :boolean
是否已启动。
Type:
- boolean
Methods
config(config)
配置模块。
Parameters:
| Name | Type | Description |
|---|---|---|
config |
JSON | 配置信息。 |
getAuthToken() → {AuthToken}
获取访问令牌。
Returns:
返回当前存储的访问令牌，如果没有获得令牌返回 null 值。
- Type
- AuthToken
getName() → {string}
获取模块名称。
Returns:
返回模块名称。
- Type
- string
getPluginSystem() → {PluginSystem}
获取插件系统对象实例。
Returns:
返回插件系统对象实例。
- Type
- PluginSystem
hasStarted() → {boolean}
是否已启动过该模块。
Returns:
如果已启动返回 true ，否则返回 false 。
- Type
- boolean
isReady() → {boolean}
模块是否就绪。
Returns:
如果模块就绪返回 true 。
- Type
- boolean
on(eventopt, listener)
- See:
设置指定事件的监听回调函数。
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
event |
string |
<optional> |
指定事件名。 |
listener |
function | 当发生该事件时回调此函数，函数参数参看 ModuleEvent 。 |
require(moduleName)
声明该模块依赖的其他模块。
Parameters:
| Name | Type | Description |
|---|---|---|
moduleName |
string |
requireFile(fileOrURL, successCallbackopt, failureCallbackopt)
请求外部依赖库文件。
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
fileOrURL |
string | 文件或者文件的 URL 。 |
|
successCallback |
function |
<optional> |
|
failureCallback |
function |
<optional> |
resume()
恢复模块。
start() → {boolean}
启动模块。
Returns:
返回 false 表示模块不再需要执行启动流程。
- Type
- boolean
stop()
停止模块。
suspend()
挂起模块。