EventQueues

EventQueues

事件队列管理类

Constructor

new EventQueues(options)

Source:

构造函数

Parameters:
Name Type Description
options object

配置选项见EventQueues.options

Members

(static, readonly) options :object

Source:
Since:
  • 1.0.0
Properties:
Name Type Default Description
debug boolean false

打印器调试模式是否开启
name string 'EventQueues'

打印器名称标记
separator string '.'

子命名空间分割符

默认配置选项

Type:
  • object

(readonly) $options :object

Source:
Since:
  • 1.0.0

实例初始配置项

Type:
  • object

(readonly) $queues :object

Source:
Since:
  • 1.0.0

事件队列集合

Type:
  • object

(readonly) $separator :string

Source:
Since:
  • 1.0.0

获取实例配置的分割符

Type:
  • string

(readonly) $name :string

Source:
Since:
  • 1.0.0

获取打印器实例的名称标记

Type:
  • string

(readonly) $debug :boolean

Source:
Since:
  • 1.0.0

获取实例的调试配置项

Type:
  • boolean

Methods

(static) config(options) → {EventQueues}

Source:
Since:
  • 1.0.0
See:

更新默认配置选项

Parameters:
Name Type Description
options object

配置选项见EventQueues.options
Returns:
Type
EventQueues

on(name, done, isAsyncopt) → {EventQueues}

Source:
Since:
  • 1.0.0

绑定队列事件

Parameters:
Name Type Attributes Default Description
name string

命名空间名称，支持多个子命名空间，用'.'号分隔，如mainname1.subname2.subname3
done function

事件句柄
isAsync boolean <optional>
 false

是否为异步，如果是异步，则需要等待该事件执行完毕，再执行一个
如果异步事件的执行结果不依赖与上一个的执行结果，则可以不传入该字段
Returns:
Type
EventQueues

off(name, doneopt) → {EventQueues}

Source:
Since:
  • 1.0.0

移除队列事件

Parameters:
Name Type Attributes Description
name string

命名空间名称，支持多个子命名空间，用'.'号分隔，如mainname1.subname2.subname3
done function <optional>

移除指定的事件，若未指定，则移除该命名空间下所有事件队列
Returns:
Type
EventQueues

(async) emit(name, …args) → {Promise}

Source:
Since:
  • 1.0.0

执行队列事件，上一个队列项的执行结果将作为下一个队列项的参数传入

Parameters:
Name Type Attributes Description
name string

命名空间名称，支持多个子命名空间，用'.'号分隔，如mainname1.subname2.subname3
args array <repeatable>

参数列表，会将参数列表作为第一个事件队列的参数传入
Returns:
Type
Promise