Lupa API Reference / @pawel-up/lupa/testing / oneEvent

Function: oneEvent()

oneEvent<T, E>(element, eventName): Promise<E>

Defined in: src/testing/helpers.ts:39

Returns a promise that resolves when the specified event is dispatched on the element.

Type Parameters

T

T = any

Type of the event detail, only relevant for CustomEvents

E

E extends Event = CustomEvent<T>

Type of the event, defaults to CustomEvent<T>

Parameters

element

EventTarget

eventName

string

Name of the event to wait for

Returns

Promise<E>

Promise that resolves when the specified event is dispatched on the element

Example

const event = await oneEvent(element, 'click')
assert.strictEqual(event.type, 'click')