TypedEventTarget

This type is a superset of TypedEventEmitter that allows you to constrain calls to dispatchEvent.

Example

const target: TypedEventTarget<{ candyVended: CustomEvent<{ flavour: string }> }> = new EventTarget();
target.dispatchEvent(new CustomEvent('candyVended', { detail: { flavour: 'raspberry' } })); // OK.
target.dispatchEvent(new CustomEvent('candyVended', { detail: { flavor: 'raspberry' } })); // ERROR. Misspelling in detail.

Type Parameters

Type Parameter
`TEventMap` extends `EventMap`

Methods

addEventListener()

addEventListener<TEventType>(
   type,
   listener,
   options?): void;

Type Parameters

Type Parameter
`TEventType` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`type`	`TEventType`
`listener`	`Listener`<`TEventMap`[`TEventType`]>
`options?`	`boolean` \| `AddEventListenerOptions`

Returns

void

dispatchEvent()

dispatchEvent<TEventType>(ev): void;

Type Parameters

Type Parameter
`TEventType` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`ev`	`TEventMap`[`TEventType`]

Returns

void

removeEventListener()

removeEventListener<TEventType>(
   type,
   listener,
   options?): void;

Type Parameters

Type Parameter
`TEventType` extends `string` \| `number` \| `symbol`

Parameters

Parameter	Type
`type`	`TEventType`
`listener`	`Listener`<`TEventMap`[`TEventType`]>
`options?`	`boolean` \| `EventListenerOptions`

Returns

void

TypedEventTarget

On this page