Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@whatwg-node/events

ardatan12.7mMIT0.1.2TypeScript support: included

Cross Platform Smart Event API Ponyfill

readme

@whatwg-node/events

A ponyfill package for JavaScript DOM Events Standard. If your JavaScript environment doesn't implement this standard natively, this package automatically ponyfills the missing parts, and export them as a module.

Installation

yarn add @whatwg-node/events

Usage

import { Event, EventTarget } from '@whatwg-node/events'

const target = new EventTarget()
target.addEventListener('foo', (event: Event) => {
  console.log(event.type) // foo
})

target.dispatchEvent(new Event('foo'))

If your environment already implements these natively, this package will export the native ones automatically.

Custom Events

import { CustomEvent, EventTarget } from '@whatwg-node/events'

const target = new EventTarget()
target.addEventListener('foo', (event: CustomEvent) => {
  console.assert(event.detail.foo, 'bar')
})

// `detail` can take any value
target.dispatchEvent(new CustomEvent('foo', { detail: { foo: 'bar' } }))

API

The following classes are exported by this package: