Core Events

Events are broadcast notifications. They say "this happened" and do not return a value.

Each container owns its own EventBus. Events stay in that container and do not bubble to a parent container.

Event types can be strings, symbols, or numbers. Payload and source are optional. undefined payloads and sources are omitted from the delivered event object, while other falsy values such as null, 0, and false are preserved.

Register the Plugin

The event bus is opt-in. Register EventsPlugin on the container so inject(EventBus), direct subscriptions, and @OnEvent handlers work. A service that declares @OnEvent throws at provision unless EventsPlugin is registered somewhere in the container chain.

import { Container, EventsPlugin } from "@wirestate/core";

const container = new Container({
  bindings: [CartService],
  plugins: [new EventsPlugin()],
});

See Core Plugins for inheritance and registering the plugin on a parent container.

Emit from a Service

import { EventBus, Injectable, inject } from "@wirestate/core";

@Injectable()
export class CartService {
  public constructor(private readonly events: EventBus = inject(EventBus)) {}

  public addItem(item: CartItem): void {
    this.events.emit("CART_ITEM_ADDED", item, { source: this });
  }
}

Use source when handlers need to know where the event came from. It is diagnostic context, not a routing key.

Handle with a Decorator

import { Injectable, OnEvent, WireEvent, inject } from "@wirestate/core";

@Injectable()
export class AnalyticsService {
  @OnEvent("CART_ITEM_ADDED")
  public trackAdd(event: WireEvent<CartItem>): void {
    this.track("add_to_cart", event.payload);
  }

  private track(name: string, payload: unknown): void {
    console.log(name, payload);
  }
}

Useful forms:

• @OnEvent("TYPE") listens to one type.
• @OnEvent(["A", "B"]) listens to several types.
• @OnEvent() listens to everything on the container event bus.

Decorated handlers subscribe during container provision and unsubscribe during deprovision. They can receive events emitted from @OnProvision and @OnDeprovision, because handlers are wired before provision hooks run and removed after deprovision hooks finish.

Subscribe Directly

Use direct subscriptions when the handler is dynamic or created at runtime.

import { Container, EventBus, EventsPlugin } from "@wirestate/core";

const container = new Container({ plugins: [new EventsPlugin()] });
const bus = container.get(EventBus);

const unsubscribe = bus.subscribe((event) => {
  console.log(event.type);
});

bus.emit("CART_VIEWED");
unsubscribe();

Pass one or more event types to receive only matching events. The bus indexes handlers by type, so unmatched events never reach the handler and no manual filtering is needed.

const unsubscribe = bus.subscribe(["CART_VIEWED", "CART_CLEARED"], (event) => {
  console.log(event.type);
});

Pass null, or call subscribe(handler), to subscribe to every event. Catch-all handlers run before type-specific handlers for the same emit. An empty type array subscribes to nothing.

Each subscription is independent. Subscribing the same function twice receives the event twice, and the returned unsubscriber removes only the subscription it came from.

Subscribe from a Service

When a service owns a dynamic subscription, attach it during provider lifecycle and remove it during deprovision.

import { EventBus, EventUnsubscribe, Injectable, OnDeprovision, OnProvision, inject } from "@wirestate/core";

@Injectable()
export class CartActivityService {
  private unsubscribe: EventUnsubscribe | null = null;

  public constructor(private readonly events: EventBus = inject(EventBus)) {}

  @OnProvision()
  public onProvision(): void {
    this.unsubscribe = this.events.subscribe("CART_VIEWED", () => {
      this.recordView();
    });
  }

  @OnDeprovision()
  public onDeprovision(): void {
    this.unsubscribe?.();
    this.unsubscribe = null;
  }

  private recordView(): void {
    console.log("cart viewed");
  }
}

Use this pattern when the subscription depends on runtime state or cannot be expressed with @OnEvent.

If an event handler throws, Wirestate reports the failure through the container error handler and continues with the next handler.

API Reference

EventBus, EventsPlugin, OnEvent, WireEvent, EventType, EventHandler, EventUnsubscribe, EventEmitOptions, OnProvision, OnDeprovision.