@thi.ng/interceptors/api.d.ts

Interceptor based event bus, side effect & immutable state handling

import type { ReadonlyAtom } from "@thi.ng/atom";
export type InterceptorFn = (state: any, e: Event, bus: IDispatch, ctx: InterceptorContext) => InterceptorContext | void;
export type InterceptorPredicate = (state: any, e: Event, bus: IDispatch, ctx: InterceptorContext) => boolean;
export type SideEffect = (x: any, bus: IDispatch, ctx: InterceptorContext) => any;
export type EventDef = Interceptor | InterceptorFn | (Interceptor | InterceptorFn)[];
export type EffectDef = SideEffect | [SideEffect, number];
export type AsyncEffectDef = [string, any, string, string];
export type EffectPriority = [string, number];
export declare const EV_SET_VALUE = "--set-value";
export declare const EV_UPDATE_VALUE = "--update-value";
export declare const EV_TOGGLE_VALUE = "--toggle-value";
export declare const FX_CANCEL = "--cancel";
export declare const FX_DISPATCH = "--dispatch";
export declare const FX_DISPATCH_ASYNC = "--dispatch-async";
export declare const FX_DISPATCH_NOW = "--dispatch-now";
export declare const FX_DELAY = "--delay";
export declare const FX_FETCH = "--fetch";
export declare const FX_STATE = "--state";
/**
 * Event ID to trigger redo action.
 * See `EventBus.addBuiltIns()` for further details.
 * Also see {@link snapshot} interceptor docs.
 */
export declare const EV_REDO = "--redo";
/**
 * Event ID to trigger undo action.
 * See `EventBus.addBuiltIns()` for further details.
 * Also see {@link snapshot} interceptor docs.
 */
export declare const EV_UNDO = "--undo";
export interface Event extends Array<any> {
    [0]: PropertyKey;
    [1]?: any;
}
export interface IDispatch {
    readonly state: ReadonlyAtom<any>;
    dispatch(...event: Event[]): void;
    dispatchNow(...event: Event[]): void;
    dispatchLater(event: Event, delay?: number): void;
}
export interface Interceptor {
    pre?: InterceptorFn;
    post?: InterceptorFn;
}
export interface InterceptorContext {
    [FX_STATE]?: any;
    [FX_CANCEL]?: boolean;
    [FX_DISPATCH]?: Event | Event[];
    [FX_DISPATCH_NOW]?: Event | Event[];
    [FX_DISPATCH_ASYNC]?: AsyncEffectDef | AsyncEffectDef[];
    [id: string]: any;
}
/**
 * See [thi.ng/logger](https://docs.thi.ng/umbrella/logger/) for usage.
 */
export declare const LOGGER: import("@thi.ng/logger/root").ProxyLogger;
//# sourceMappingURL=api.d.ts.map