InterfaceAddEventListener<T>

The return value of event().

interface AddEventListener<T> {
    dispose(): void;
    off(listener?: Listener<T>): boolean;
    on(listener: Listener<T>): (() => void);
    size(): number;
    (listener: Listener<T>): (() => void);
}

Type Parameters

T = void

Hierarchy (view full)

IEvent<T>
- AddEventListener

AddEventListener(listener): (() => void)
Adds a listener to the event.
Parameters
- listener: Listener<T>
  The callback to add.
Returns (() => void)
A function to remove the listener.
- - (): void
  - Returns void
- Defined in interface.ts:18

Index

Methods

dispose off on size

Methods

dispose

dispose(): void
Returns void
- Defined in interface.ts:36

off

off(listener?): boolean
Removes a listener from the event.
Parameters
- Optionallistener: Listener<T>
  The callback to remove. If omitted, all listeners are removed.
Returns boolean
Whether the listener was found and removed.
- Defined in interface.ts:34

on

on(listener): (() => void)
Adds a listener to the event.
Parameters
- listener: Listener<T>
  The callback to add.
Returns (() => void)
A function to remove the listener.
- - (): void
  - Returns void
- Defined in interface.ts:28

size

size(): number
Returns number
Size of listeners.
- Defined in interface.ts:22