@ngrx/store-devtools 12.2.0 → 12.5.1

package/src/config.d.ts

@@ -10,33 +10,102 @@ export declare type SerializationOptions = {
     refs?: Array<any>;
 };
 export declare type Predicate = (state: any, action: Action) => boolean;
+/**
+ * Chrome extension documentation
+ * @see https://github.com/reduxjs/redux-devtools/blob/main/extension/docs/API/Arguments.md#features
+ * Firefox extension documentation
+ * @see https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Arguments.md#features
+ */
 export interface DevToolsFeatureOptions {
+    /**
+     * Start/pause recording of dispatched actions
+     */
     pause?: boolean;
+    /**
+     * Lock/unlock dispatching actions and side effects
+     */
     lock?: boolean;
+    /**
+     * Persist states on page reloading
+     */
     persist?: boolean;
+    /**
+     * Export history of actions in a file
+     */
     export?: boolean;
+    /**
+     * Import history of actions from a file
+     */
     import?: 'custom' | boolean;
+    /**
+     * Jump back and forth (time travelling)
+     */
     jump?: boolean;
+    /**
+     * Skip (cancel) actions
+     */
     skip?: boolean;
+    /**
+     * Drag and drop actions in the history list
+     */
     reorder?: boolean;
+    /**
+     * Dispatch custom actions or action creators
+     */
     dispatch?: boolean;
+    /**
+     * Generate tests for the selected actions
+     */
     test?: boolean;
 }
+/**
+ * Chrome extension documentation
+ * @see https://github.com/reduxjs/redux-devtools/blob/main/extension/docs/API/Arguments.md
+ * Firefox extension documentation
+ * @see https://github.com/zalmoxisus/redux-devtools-extension/blob/master/docs/API/Arguments.md
+ */
 export declare class StoreDevtoolsConfig {
+    /**
+     * Maximum allowed actions to be stored in the history tree (default: `false`)
+     */
     maxAge: number | false;
     monitor?: ActionReducer<any, any>;
+    /**
+     * Function which takes `action` object and id number as arguments, and should return `action` object back.
+     */
     actionSanitizer?: ActionSanitizer;
+    /**
+     * Function which takes `state` object and index as arguments, and should return `state` object back.
+     */
     stateSanitizer?: StateSanitizer;
+    /**
+     * The instance name to be shown on the monitor page (default: `document.title`)
+     */
     name?: string;
     serialize?: boolean | SerializationOptions;
     logOnly?: boolean;
     features?: DevToolsFeatureOptions;
+    /**
+     * Action types to be hidden in the monitors. If `actionsSafelist` specified, `actionsBlocklist` is ignored.
+     */
     actionsBlocklist?: string[];
+    /**
+     * Action types to be shown in the monitors
+     */
     actionsSafelist?: 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.
+     */
     predicate?: Predicate;
+    /**
+     * Auto pauses when the extension’s window is not opened, and so has zero impact on your app when not in use.
+     */
     autoPause?: boolean;
 }
 export declare const STORE_DEVTOOLS_CONFIG: InjectionToken<StoreDevtoolsConfig>;
+/**
+ * Used to provide a `StoreDevtoolsConfig` for the store-devtools.
+ */
 export declare const INITIAL_OPTIONS: InjectionToken<StoreDevtoolsConfig>;
 export declare type StoreDevtoolsOptions = Partial<StoreDevtoolsConfig> | (() => Partial<StoreDevtoolsConfig>);
 export declare function noMonitor(): null;