Module: kongUtilEvent

Methods

(inner) extendEventTargetPrototype()

Add above methods to EventTarget class.

Source:

(inner) listen(target, …args) → {undefined}

Shortcut to EventTarget.addEventListner.

Parameters:
Name Type Attributes Description
target EventTarget | string

target itself, or a CSS selector which matches an Element
args any <repeatable>

arguments for addEventListener
Source:
Returns:
Type
undefined

(inner) listenMulti(targets, eventTypes, listeners, optionsopt) → {undefined}

Add multi listener to multi events on multi targets

Parameters:
Name Type Attributes Description
targets string | Element | NodeList | Array.<EventTarget>
eventTypes string | Array.<string>
listeners function | Array.<function()>
options boolean | Object <optional>
Source:
Returns:
Type
undefined

(inner) listens()

Deprecated:
  • Yes
Source:

(inner) listens()

Deprecated:
  • Yes
Source:

(inner) unlisten(target, …args) → {undefined}

Shortcut to EventTarget.removeEventListener

Parameters:
Name Type Attributes Description
target EventTarget | string
args any <repeatable>

arguments for removeEventListener
Source:
Returns:
Type
undefined

(inner) unlistenMulti(targets, eventTypes, listener, optionsopt) → {undefined}

Remove multi listener to multi events on multi targets

Parameters:
Name Type Attributes Description
targets string | NodeList | Array.<EventTarget>
eventTypes string | Array.<string>
listener function | Array.<function()>
options boolean | Object <optional>
Source:
Returns:
Type
undefined

(inner) waitForEvent(target, type, optionsopt) → {Promise.<Event>}

Resolves to the event, or rejects if timeout milliseconds passed.

Parameters:
Name Type Attributes Description
target EventTarget | string
type string
options number | string | boolean | Object <optional>

If omitted or being a non-positive number, the promise would never reject. If it's a positive number or a numeric string, the value is treated as the timeout. If it's a boolean, the value is used as useCapture for EventTarget.addEventListener. If it's an object, the property except the followings are used as options for EventTarget.addEventListener.

Properties
Name Type Attributes Description
timeout number | string <optional>

timeout in milliseconds
preventDefault boolean <optional>

wheather to call Event.preventDefault
stopPropagation boolean <optional>

wheather to call Event.stopPropagation
stopImmediatePropagation boolean <optional>

wheather to call Event.stopImmediatePropagation
Source:
Returns:
Type
Promise.<Event>
Example
/// rejects if no click to `document.body` in 1 second
    waitForEvent(document.body, "click", 1000)
    .then(() => console.log("a click event in 1 second is detected"));