Skip to content

Function: OnEvent()

ts
function OnEvent(event, options?): MethodDecorator;

Defined in: packages/event-emitter/src/decorators/on-event.decorator.ts:45

Marks a method as a listener for the given event (or wildcard pattern).

The method is automatically registered during onModuleInit by EventEmitterExplorer — no extra wiring is required.

Parameters

ParameterTypeDescription
eventstring | symbolEvent name, wildcard pattern ("order.*", "**"), or symbol.
optionsOnEventOptionsOptional configuration.

Returns

MethodDecorator

Example

typescript
@Injectable()
export class NotificationListener {
  @OnEvent('order.created')
  handleOrderCreated(order: Order) {
    console.log('New order:', order.id);
  }

  @OnEvent('order.*')
  handleAnyOrderEvent(payload: unknown) {
    console.log('Order event fired');
  }
}

Released under the MIT License.