Interface Listener

Adds types to the EventTarget class. Hopefully this won't be necessary forever.

https://github.com/microsoft/TypeScript/issues/28357 https://github.com/microsoft/TypeScript/issues/43477 https://github.com/microsoft/TypeScript/issues/299 etc

Hierarchy

EventEmitter<ListenerEvents>
- Listener

Index

Properties

#private close getAddrs listen

Methods

addEventListener dispatchEvent listenerCount removeEventListener safeDispatchEvent

Properties

`Private` #private

#private: any

close

close: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Close listener
  
  Returns
  
  Returns Promise<void>

getAddrs

getAddrs: (() => Multiaddr[])

Type declaration

- (): Multiaddr[]
- Get listen addresses
  
  Returns Multiaddr[]

listen

listen: ((multiaddr: Multiaddr) => Promise<void>)

Type declaration

- (multiaddr: Multiaddr): Promise<void>
- Start a listener
  Parameters
  - multiaddr: Multiaddr
  Returns Promise<void>

Methods

addEventListener

addEventListener<K>(type: K, listener: null | EventHandler<ListenerEvents[K]>, options?: boolean | AddEventListenerOptions): void
Type Parameters
- K extends keyof ListenerEvents
Parameters
- type: K
- listener: null | EventHandler<ListenerEvents[K]>
- Optional options: boolean | AddEventListenerOptions
Returns void
Inherited from EventEmitter.addEventListener
- Defined in packages/interfaces/dist/src/events.d.ts:19

dispatchEvent

dispatchEvent(event: Event): boolean
Parameters
- event: Event
Returns boolean
Inherited from EventEmitter.dispatchEvent
- Defined in packages/interfaces/dist/src/events.d.ts:21

listenerCount

listenerCount(type: string): number
Parameters
- type: string
Returns number
Inherited from EventEmitter.listenerCount
- Defined in packages/interfaces/dist/src/events.d.ts:18

removeEventListener

removeEventListener<K>(type: K, listener?: null | EventHandler<ListenerEvents[K]>, options?: boolean | EventListenerOptions): void
Type Parameters
- K extends keyof ListenerEvents
Parameters
- type: K
- Optional listener: null | EventHandler<ListenerEvents[K]>
- Optional options: boolean | EventListenerOptions
Returns void
Inherited from EventEmitter.removeEventListener
- Defined in packages/interfaces/dist/src/events.d.ts:20

safeDispatchEvent

safeDispatchEvent<Detail>(type: keyof ListenerEvents, detail: CustomEventInit<Detail>): boolean
Type Parameters
- Detail
Parameters
- type: keyof ListenerEvents
- detail: CustomEventInit<Detail>
Returns boolean
Inherited from EventEmitter.safeDispatchEvent
- Defined in packages/interfaces/dist/src/events.d.ts:22