@ngrx/signals/events/src/inject-dispatch.d.ts

Reactive Store and Set of Utilities for Angular Signals

import { Injector } from '@angular/core';
import { Prettify } from '@ngrx/signals';
import { EventCreator } from './event-creator';
type InjectDispatchResult<EventGroup extends Record<string, EventCreator<string, any>>> = {
    [EventName in keyof EventGroup]: Parameters<EventGroup[EventName]> extends [
        infer Payload
    ] ? (payload: Payload) => void : () => void;
};
/**
 * @experimental
 * @description
 *
 * Creates self-dispatching events for a given event group.
 *
 * @usageNotes
 *
 * ```ts
 * import { type } from '@ngrx/signals';
 * import { eventGroup, injectDispatch } from '@ngrx/signals/events';
 *
 * const counterPageEvents = eventGroup({
 *   source: 'Counter Page',
 *   events: {
 *     increment: type<void>(),
 *     decrement: type<void>(),
 *   },
 * });
 *
 * \@Component({ \/* ... *\/ })
 * class Counter {
 *   readonly dispatch = injectDispatch(counterPageEvents);
 *
 *   increment(): void {
 *     this.dispatch.increment();
 *   }
 *
 *   decrement(): void {
 *     this.dispatch.decrement();
 *   }
 * }
 * ```
 */
export declare function injectDispatch<EventGroup extends Record<string, EventCreator<string, any>>>(events: EventGroup, config?: {
    injector?: Injector;
}): Prettify<InjectDispatchResult<EventGroup>>;
export {};