use-app-events/dist/base/types.d.ts

Event system for global communication in vanilla JavaScript and React.

import { AsyncCallback, Callback, CleanupFunction } from '../types';
export type BaseListenForEventsOptions = {
    debug?: boolean;
    scopeKey?: string;
    shouldBeCalledOnce?: boolean;
};
export type BaseNotifyEventListenersOptions = {
    debug?: boolean;
    scopeKey?: string;
};
export type BaseListenForEvents<EventType extends string> = {
    /** Subscribe and listen for the specified event type to occur in the app. */
    <Type extends EventType, Payload>(eventType: Type, callback: Callback<void> | Callback<Payload> | AsyncCallback<void> | AsyncCallback<Payload>): CleanupFunction;
    /** Subscribe and listen for the specified event types to occur in the app. */
    <Type extends EventType, Payload>(eventTypes: Type[], callback: Callback<void> | Callback<Type> | Callback<[Type, Payload]> | AsyncCallback<void> | AsyncCallback<Type> | AsyncCallback<[Type, Payload]>): CleanupFunction;
};
export type BaseNotifyEventListeners<EventType extends string> = {
    /** Notify all listeners of the specified event type subscribed via `listenForEvents`. */
    <Payload, Type extends EventType>(eventType: Type, payload?: Payload, broadcast?: boolean): void;
    /** Notify all listeners of the specified event types subscribed via `listenForEvents`. */
    <Payload, Type extends EventType>(eventTypes: Type[], payload?: Payload, broadcast?: boolean): void;
};