API Docs for: undefined
Show:

Plugin.AsyncPause Class

Extends Plugin.Base
Defined in: js/async-pause.js:18

Asynchronous command runner pause plugin.

Item Index

Methods

Attributes

Methods

pause

() chainable

Defined in js/async-pause.js:40

Pause the run. Does not stop a command that is currently running, the run will pause before the next command runs.

resume

() chainable

Defined in js/async-pause.js:49

Resumes a paused run. If a command is currently running, the paused state may not be updated immediately. Resume does nothing if the run is not paused or not started yet or already complete.

Attributes

_args

Array protected

Defined in js/async-pause.js:114

Paused _runQueue arguments.

Fires event _argsChange

Fires when the value for the configuration attribute _args is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

_resumed

Array protected

Defined in js/async-pause.js:125

Boolean value indicating the resumed status of the run.

Fires event _resumedChange

Fires when the value for the configuration attribute _resumed is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.

paused

Boolean

Defined in js/async-pause.js:103

Boolean value indicating the paused status of the run.

Default: false

Fires event pausedChange

Fires when the value for the configuration attribute paused is changed. You can listen for the event using the on method if you wish to be notified before the attribute's value has changed, or using the after method if you wish to be notified after the attribute's value has changed.

Parameters:

  • e EventFacade
    An Event Facade object with the following attribute-specific properties added:
    • prevVal Any
      The value of the attribute, prior to it being set.
    • newVal Any
      The value the attribute is to be set to.
    • attrName String
      The name of the attribute being set.
    • subAttrName String
      If setting a property within the attribute's value, the name of the sub-attribute property being set.