@ngxs/devtools-plugin/index.d.ts

redux devtools plugin for @ngxs/store

import * as i0 from '@angular/core';
import { InjectionToken, ModuleWithProviders, EnvironmentProviders, OnDestroy } from '@angular/core';
import { NgxsPlugin, NgxsNextPluginFn } from '@ngxs/store/plugins';

/**
 * Interface for the redux-devtools-extension API.
 */
interface NgxsDevtoolsExtension {
    init(state: any): void;
    send(action: any, state?: any): void;
    subscribe(fn: (message: NgxsDevtoolsAction) => void): VoidFunction;
}
interface NgxsDevtoolsAction {
    type: string;
    payload: any;
    state: any;
    id: number;
    source: string;
}
interface NgxsDevtoolsOptions {
    /**
     * The name of the extension
     */
    name?: string;
    /**
     * Whether the dev tools is enabled or note. Useful for setting during production.
     */
    disabled?: boolean;
    /**
     * Max number of entiries to keep.
     */
    maxAge?: number;
    /**
     * If more than one action is dispatched in the indicated interval, all new actions will be collected
     * and sent at once. It is the joint between performance and speed. When set to 0, all actions will be
     * sent instantly. Set it to a higher value when experiencing perf issues (also maxAge to a lower value).
     * Default is 500 ms.
     */
    latency?: number;
    /**
     * string or array of strings as regex - actions types to be hidden in the monitors (while passed to the reducers).
     * If actionsWhitelist specified, actionsBlacklist is ignored.
     */
    actionsBlacklist?: string | string[];
    /**
     * string or array of strings as regex - actions types to be shown in the monitors (while passed to the reducers).
     * If actionsWhitelist specified, actionsBlacklist is ignored.
     */
    actionsWhitelist?: string | string[];
    /**
     * called for every action before sending, takes state and action object, and returns true in case it allows
     * sending the current data to the monitor. Use it as a more advanced version of
     * actionsBlacklist/actionsWhitelist parameters
     */
    predicate?: (state: any, action: any) => boolean;
    /**
     * Reformat actions before sending to dev tools
     */
    actionSanitizer?: (action: any) => void;
    /**
     * Reformat state before sending to devtools
     */
    stateSanitizer?: (state: any) => void;
    /**
     * If set to true, will include stack trace for every dispatched action
     */
    trace?: boolean | (() => string);
    /**
     * Maximum stack trace frames to be stored (in case trace option was provided as true)
     */
    traceLimit?: number;
}
declare const NGXS_DEVTOOLS_OPTIONS: InjectionToken<NgxsDevtoolsOptions>;

declare class NgxsReduxDevtoolsPluginModule {
    static forRoot(options?: NgxsDevtoolsOptions): ModuleWithProviders<NgxsReduxDevtoolsPluginModule>;
    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsReduxDevtoolsPluginModule, never>;
    static ɵmod: i0.ɵɵNgModuleDeclaration<NgxsReduxDevtoolsPluginModule, never, never, never>;
    static ɵinj: i0.ɵɵInjectorDeclaration<NgxsReduxDevtoolsPluginModule>;
}
declare function withNgxsReduxDevtoolsPlugin(options?: NgxsDevtoolsOptions): EnvironmentProviders;

/**
 * Adds support for the Redux Devtools extension:
 * http://extension.remotedev.io/
 */
declare class NgxsReduxDevtoolsPlugin implements OnDestroy, NgxsPlugin {
    private _injector;
    private _ngZone;
    private _options;
    private devtoolsExtension;
    private readonly globalDevtools;
    private unsubscribe;
    constructor();
    ngOnDestroy(): void;
    /**
     * Lazy get the store for circular dependency issues
     */
    private get store();
    /**
     * Middleware handle function
     */
    handle(state: any, action: any, next: NgxsNextPluginFn): any;
    private sendToDevTools;
    /**
     * Handle the action from the dev tools subscription
     */
    dispatched(action: NgxsDevtoolsAction): void;
    private connect;
    static ɵfac: i0.ɵɵFactoryDeclaration<NgxsReduxDevtoolsPlugin, never>;
    static ɵprov: i0.ɵɵInjectableDeclaration<NgxsReduxDevtoolsPlugin>;
}

export { NGXS_DEVTOOLS_OPTIONS, type NgxsDevtoolsAction, type NgxsDevtoolsExtension, type NgxsDevtoolsOptions, NgxsReduxDevtoolsPlugin, NgxsReduxDevtoolsPluginModule, withNgxsReduxDevtoolsPlugin };