TypedEventEmitter

This type allows you to type addEventListener and removeEventListener so that the call signature of the listener matches the event type given.

Example

const emitter: TypedEventEmitter<{ message: MessageEvent }> = new WebSocket('wss://api.devnet.solana.com');
emitter.addEventListener('data', handleData); // ERROR. `data` is not a known event type.
emitter.addEventListener('message', message => {
    console.log(message.origin); // OK. `message` is a `MessageEvent` so it has an `origin` property.
});

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

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

TypedEventEmitter

On this page