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

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

import { type Accessor, type Setter } from "solid-js";
import { type Emit, type Listen } from "./eventBus.js";
export type EventStackPayload<E, V = E> = {
    readonly event: V;
    readonly stack: V[];
    readonly remove: VoidFunction;
};
export type EventStack<E, V = E> = {
    readonly listen: Listen<EventStackPayload<V>>;
    readonly clear: VoidFunction;
    readonly value: Accessor<V[]>;
    readonly setValue: Setter<V[]>;
    readonly remove: (value: V) => boolean;
    readonly emit: Emit<E>;
};
export type EventStackConfig<E, V = E> = {
    readonly length?: number;
    readonly toValue?: (event: E, stack: V[]) => V;
};
/**
 * Provides all the base functions of an event-emitter, functions for managing listeners, it's behavior could be customized with an config object.
 * Additionally it provides the emitted events in a list/history form, with tools to manage it.
 *
 * @returns event stack: `{listen, emit, remove, clear, value, setValue}`
 *
 * @see https://github.com/solidjs-community/solid-primitives/tree/main/packages/event-bus#createEventStack
 *
 * @example
const bus = createEventStack<{ message: string }>();
// can be destructured:
const { listen, emit, clear, value } = bus;

const listener: EventStackListener<{ text: string }> = ({ event, stack, remove }) => {
  console.log(event, stack);
  // you can remove the value from stack
  remove();
};
bus.listen(listener);

bus.emit({ text: "foo" });

// a signal accessor:
bus.value() // => { text: string }[]

bus.setValue(stack => stack.filter(item => {...}))
 */
export declare function createEventStack<E extends object>(config?: EventStackConfig<E>): EventStack<E, E>;
export declare function createEventStack<E, V extends object>(config: EventStackConfig<E, V> & {
    toValue: (event: E, stack: V[]) => V;
}): EventStack<E, V>;