API Reference
Rockets Core API
nestjs-event
interfaces
EventListenOnInterface

Interface: EventListenOnInterface<E>

The interface that defines Event Listen On signature.

Extends

Type Parameters

Type Parameter
E

Properties

PropertyTypeDescription
optionsEventListenOnOptionsInterfaceOptions to be passed to Event Emitter 2 at the time of subscription.

Methods

listen()

listen(event): EventReturnType<E>

Listener handler.

Parameters

ParameterTypeDescription
eventEventInstance<E>An event instance

Returns

EventReturnType<E>

Inherited from

EventListenerInterface.listen

Defined in

.tmp/repos/rockets/packages/nestjs-event/src/listeners/interfaces/event-listener.interface.ts:13 (opens in a new tab)


remove()

remove(): void

Remove the subscription.

Returns

void

Inherited from

EventListenerInterface.remove

Defined in

.tmp/repos/rockets/packages/nestjs-event/src/listeners/interfaces/event-listener.interface.ts:25 (opens in a new tab)


subscription()

subscription(emitterListener): void

Called after successful subscription.

Parameters

ParameterTypeDescription
emitterListenerListenerThe Listener object returned by EventEmitter2

Returns

void

Inherited from

EventListenerInterface.subscription

Defined in

.tmp/repos/rockets/packages/nestjs-event/src/listeners/interfaces/event-listener.interface.ts:20 (opens in a new tab)