js-trigger

Trigger

Trigger是一个JavaScript触发器插件，可通过指定频次、指定时间内触发指定的处理函数，使用场景如：限制日志频繁上传、限制ajax频繁调用、错误提醒、网络状态检测等

Kind: global class
Version: 1.0.0
Author: Tango tanwei_yx@126.com

• Trigger
  • new Trigger(props)
  • instance
    • .check(data)
    • .open()
    • .stop()
    • .reset(props)
    • .trigger()
    • .on(handler)
    • .off(handler)
  • static
    • .checkConfig(props) ⇒ boolean
    • .create(props)
    • .each()
    • .resetAll()
    • .openAll()
    • .stopAll()
    • .removeAll()
  • inner
    • ~handler : function

new Trigger(props)

创建一个触发器实例 frequency/interval 至少传入一个

Example

new Trigger({
  name: '',
  frequency: 5,
  interval: 30
})

Trigger.create({
  name: '',
  frequency: 5,
  interval: 30
})

trigger.check(data)

检查触发器，条件成立会即可触发处理函数

Kind: instance method of Trigger

trigger.open()

打开触发器

Kind: instance method of Trigger

trigger.stop()

停止触发器，可通过open重新打开

Kind: instance method of Trigger

trigger.reset(props)

重置触发器，同时也会打开触发器

Kind: instance method of Trigger

trigger.trigger()

执行触发器处理函数

Kind: instance method of Trigger

trigger.on(handler)

触发器监听事件，条件满足立刻触发处理函数

Kind: instance method of Trigger

trigger.off(handler)

移除触发器监听事件

Kind: instance method of Trigger

Trigger.checkConfig(props) ⇒ boolean

检查触发器配置是否有效

Kind: static method of Trigger

Trigger.create(props)

创建一个触发器实例

Kind: static method of Trigger

Trigger.each()

遍历所有触发器实例

Kind: static method of Trigger

Trigger.resetAll()

重置所有触发器实例，同时也会打开触发器

Kind: static method of Trigger

Trigger.openAll()

打开所有触发器实例

Kind: static method of Trigger

Trigger.stopAll()

停止所有触发器实例

Kind: static method of Trigger

Trigger.removeAll()

移除所有触发器实例

Kind: static method of Trigger

Trigger~handler : function

触发器监听事件处理函数

Kind: inner typedef of Trigger