Class EventBus<TEvents, TPayloadMap>

EventBus v2.0 - Sistema de eventos type-safe e configurável.

Biblioteca genérica para pub/sub que pode ser consumida via CDN. Clientes definem seus próprios tipos de eventos através de generics.

Example: Uso simples sem tipos de payload

const bus = EventBus.getInstance<'userLogin' | 'userLogout'>();
bus.subscribe('userLogin', (data) => console.log(data));
bus.publish('userLogin', { userId: '123' });

Example: Uso avançado com payloads tipados

type MyEvents = 'login' | 'logout';
interface MyPayloads extends EventPayloadMap<MyEvents> {
  login: { userId: string; timestamp: Date };
  logout: { reason: string };
}

const bus = EventBus.create<MyEvents, MyPayloads>({
  allowedEvents: ['login', 'logout'],
  validateEvents: true,
  enableMetrics: true
});

bus.subscribe('login', (payload) => {
  // payload é tipado como { userId: string; timestamp: Date }
  console.log(payload.userId);
});

Type Parameters

  • TEvents extends string = string

    União de strings literais dos eventos permitidos (ex: 'login' | 'logout')

  • TPayloadMap extends EventPayloadMap<TEvents> = EventPayloadMap<TEvents>

    Mapa opcional de tipos de payload por evento

Methods

clearAllEvents clearEvent getConfig getEventNames getMetrics getSubscriberCount hasSubscribers publish subscribe unsubscribe create getInstance resetInstance

Methods

clearAllEvents

  • clearAllEvents(): void

  • Limpa todos os eventos e callbacks registrados no EventBus.

    Returns void

    Example

    bus.clearAllEvents();

clearEvent

  • clearEvent(eventName: TEvents): void

  • Limpa todos os callbacks inscritos para um evento específico.

    Parameters

    • eventName: TEvents

      Nome do evento a limpar

    Returns void

    Example

    bus.clearEvent('login');

getConfig

getEventNames

  • getEventNames(): TEvents[]

  • Retorna lista de nomes de eventos que possuem pelo menos um subscriber.

    VERSÃO 2.0: Substitui acesso direto ao campo events que agora é privado.

    Returns TEvents[]

    Array com nomes dos eventos ativos

    Example

    const activeEvents = bus.getEventNames();
    console.log('Eventos ativos:', activeEvents);

getMetrics

  • getMetrics(): null | EventBusMetrics

  • Retorna as métricas coletadas (se enableMetrics=true).

    Returns null | EventBusMetrics

    Objeto com métricas ou null se métricas estiverem desabilitadas

    Example

    const metrics = bus.getMetrics();
    if (metrics) {
      console.log('Total de publishes:', metrics.totalPublishes);
      console.log('Subscriptions por evento:', metrics.byEvent);
    }

getSubscriberCount

  • getSubscriberCount(eventName: TEvents): number

  • Retorna o número de subscribers para um evento específico.

    Parameters

    Returns number

    Número de subscribers (0 se não houver)

    Example

    const count = bus.getSubscriberCount('login');
    console.log(`${count} subscribers para login`);

hasSubscribers

  • hasSubscribers(eventName: TEvents): boolean

  • Verifica se um evento possui subscribers.

    Parameters

    • eventName: TEvents

      Nome do evento a verificar

    Returns boolean

    true se o evento possui ao menos um subscriber

    Example

    if (bus.hasSubscribers('login')) {
      console.log('Há subscribers para login');
    }

publish

  • publish<E extends string>(
        eventName: E,
        ...args: E extends keyof TPayloadMap
            ? [payload: ExtractEventPayload<TPayloadMap, E<E>>]
            : any[],
    ): void

  • Publica um evento, executando todos os callbacks inscritos para ele.

    Erros em callbacks individuais não interrompem a execução dos demais. Callbacks são executados na ordem de inscrição.

    Type Parameters

    • E extends string

      Tipo específico do evento (inferido automaticamente)

    Parameters

    Returns void

    Throws

    Error se validateEvents=true e o evento não for permitido

    Example

    bus.publish('login', { userId: '123', timestamp: new Date() });

subscribe

  • subscribe<E extends string>(
        eventName: E,
        callback: E extends keyof TPayloadMap
            ? (payload: ExtractEventPayload<TPayloadMap, E<E>>) => void
            : GenericEventCallback,
    ): Unsubscribe

  • Inscreve um callback para um evento específico.

    Type Parameters

    • E extends string

      Tipo específico do evento (inferido automaticamente)

    Parameters

    Returns Unsubscribe

    Função para desinscrever (Unsubscribe)

    Throws

    Error se validateEvents=true e o evento não for permitido

    Example

    const unsubscribe = bus.subscribe('login', (payload) => {
      console.log('User logged in:', payload);
    });

    // Mais tarde, remover a inscrição
    unsubscribe();

unsubscribe

  • unsubscribe(eventName: TEvents, callback: GenericEventCallback): void

  • Desinscreve um callback específico de um evento.

    Parameters

    Returns void

    Example

    const callback = (data) => console.log(data);
    bus.subscribe('login', callback);
    bus.unsubscribe('login', callback);

Staticcreate

StaticgetInstance

  • getInstance<
        TEvents extends string = string,
        TPayloadMap extends EventPayloadMap<TEvents> = EventPayloadMap<TEvents>,
    >(
        config?: EventBusConfig<TEvents>,
    ): EventBus<TEvents, TPayloadMap>

  • Retorna a instância singleton do EventBus.

    IMPORTANTE: A configuração só é aplicada na primeira chamada. Chamadas subsequentes ignoram o parâmetro config e retornam a instância existente.

    Type Parameters

    Parameters

    Returns EventBus<TEvents, TPayloadMap>

    A instância singleton do EventBus

    Example

    // Primeira chamada - configura o singleton
    const bus = EventBus.getInstance<'login' | 'logout'>({
      allowedEvents: ['login', 'logout'],
      validateEvents: true
    });

    // Chamadas subsequentes - retorna instância configurada
    const sameBus = EventBus.getInstance(); // config é ignorado

StaticresetInstance

  • resetInstance(): void

  • Reseta a instância singleton do EventBus.

    ⚠️ ATENÇÃO: Este método deve ser usado APENAS em testes. Não use em código de produção.

    Returns void

    Example

    // Em um arquivo de teste
    afterEach(() => {
      EventBus.resetInstance();
    });

Settings

Member Visibility

On This Page

Methods