Class EventEmitter<TEvent>

Event emitter is a handy implementation of OnEvent sender.

Extends EventNotifier by making its on method implement an OnEvent interface.

Type Parameters

TEvent extends any[]

An event type. This is a list of event receiver parameter types.

Hierarchy

EventNotifier<TEvent>
- EventEmitter

Implements

EventSender<TEvent>

Index

Constructors

Properties

Accessors

Methods

[OnEvent__symbol]

Constructors

constructor

new EventEmitter<TEvent>(): EventEmitter<TEvent>
Type Parameters
- TEvent extends any[]
Returns EventEmitter<TEvent>
Inherited from EventNotifier.constructor
- Defined in proc7ts/fun-events/src/base/event-notifier.ts:32

Properties

`Readonly` on

on: OnEvent<TEvent> = ...

OnEvent sender of emitted events.

The [OnEvent__symbol] method is an alias of this one.

`Readonly` send

send: ((this, ...event) => void)

Type declaration

- (this, ...event): void
- Sends the given event to all registered receivers.
  Parameters
  - this: EventEmitter<TEvent>
  - Rest ...event: TEvent
    
    An event to send represented by function call arguments.
  Returns void

`Readonly` supply

supply: Supply

Accessors

size

get size(): number
The number of currently registered event receivers.

Returns number
Inherited from EventNotifier.size
- Defined in proc7ts/fun-events/src/base/event-notifier.ts:45

Methods

[OnEvent__symbol]

[OnEvent__symbol](): OnEvent<TEvent>
Returns an OnEvent instance of this event sender.

Returns OnEvent<TEvent>
OnEvent instance registering event receivers sent by this sender.
Implementation of EventSender.[OnEvent__symbol]
- Defined in proc7ts/fun-events/src/senders/event-emitter.ts:23

Generated using TypeDoc