whenEventListener

Type:Function
Status:stable
Since:1.0.0
Platform:js
@blackbyte.sugar.js.dom.when

Promisify the addEventListener method of an element to resolve a promise once the event has been triggered.

Params

  1. event*-string

    The event to listen for (e.g. ‘click’, ‘animationend’, etc.)

  2. $elm*-HTMLElement

    The element to listen on

Return

  1. -Promise<Event>

    A promise that will be resolved once the event has been triggered

Example

import { whenEventListener } from '@blackbyte/sugar/dom'
whenEventListener('click', $elm).then((e: Event) => {
  // do something...
});

Todo

  • testsnormal