@solid-primitives/event-bus/dist/eventHub.d.ts

A collection of SolidJS primitives providing various features of a pubsub/event-emitter/event-bus.

import { type Accessor } from "solid-js";
import { type EmitterEmit, type EmitterListen, type EmitterOn } from "./emitter.js";
import { createEventBus, type Emit, type Listen } from "./eventBus.js";
export type EventHubPayloadMap<M> = {
    [K in keyof M]: M[K] extends {
        emit: Emit<infer T>;
    } ? T : never;
};
export type EventHubValue<M> = {
    [K in keyof M]: M[K] extends {
        value: Accessor<infer T>;
    } ? T : never;
};
/**
 * Required interface of a EventBus, to be able to be used as a channel in the EventHub
 */
export interface EventHubChannel<T, V = T> {
    readonly listen: Listen<T>;
    readonly emit: Emit<T>;
    readonly value?: Accessor<V>;
}
export type EventHub<M extends {
    readonly [key: string | number]: EventHubChannel<any>;
}> = Readonly<M> & {
    readonly on: EmitterOn<EventHubPayloadMap<M>>;
    readonly emit: EmitterEmit<EventHubPayloadMap<M>>;
    readonly listen: EmitterListen<EventHubPayloadMap<M>>;
    readonly value: EventHubValue<M>;
};
/**
 * Provides helpers for using a group of event buses.
 *
 * Can be used with `createEventBus`, `createEventStack` or any emitter that has the same api.
 *
 * @param defineChannels object with defined channels or a defineChannels function returning channels.
 *
 * @returns hub functions: `{on, emit, listen, value}` + channels available by their key
 *
 * @see https://github.com/solidjs-community/solid-primitives/tree/main/packages/event-bus#createEventHub
 *
 * @example
 * const hub = createEventHub({
 *    busA: createEventBus<void>(),
 *    busB: createEventBus<string>(),
 *    busC: createEventStack<{ text: string }>()
 * });
 * // can be destructured
 * const { busA, busB, on, listen, emit } = hub;
 *
 * hub.on("busA", e => {});
 * hub.on("busB", e => {});
 *
 * hub.emit("busA", 0);
 * hub.emit("busB", "foo");
 */
export declare function createEventHub<M extends {
    readonly [key: string | number]: EventHubChannel<any>;
}>(defineChannels: ((bus: typeof createEventBus) => M) | M): EventHub<M>;