API Docs for:
Show:

Plugin.AsyncCommandTimeout Class

Asynchronous command timeout plugin.

Item Index

Attributes

Attributes

timeout

Number

Approximate timeout in milliseconds to wait for success before the command automatically fails. Must be a non-negative integer. A value of 0 disables the timeout.

Default: 0

Fires event timeoutChange

Fires when the value for the configuration attribute timeout 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.