mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
99f83ab60b
* chore: bumped redux version to 4.x & correct GenericStoreEnhancer import
* Redux 4 typings uses generic parameter defaults
As of TypeScript 2.3 there is [support for generic parameter defaults](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-3.html#generic-parameter-defaults). Between [redux@3.6.0 and redux@4.0.0](3e114f8c0f...e95eaf2dc2 (diff-b52768974e6bc0faccb7d4b75b162c99)) generic parameter defaults were introduced which forces `remote-redux-devtools`' to use at least TypeScript 2.3
* Adding @colindekker to the list of contributors
117 lines
4.0 KiB
TypeScript
117 lines
4.0 KiB
TypeScript
// Type definitions for remote-redux-devtools 0.5
|
|
// Project: https://github.com/zalmoxisus/remote-redux-devtools
|
|
// Definitions by: Colin Eberhardt <https://github.com/ColinEberhardt>
|
|
// Daniel Perez Alvarez <https://github.com/unindented>
|
|
// Maximo Dominguez <https://github.com/mamodom>
|
|
// Colin Dekker <https://github.com/colindekker>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.3
|
|
|
|
import {
|
|
Action,
|
|
ActionCreator,
|
|
ActionCreatorsMapObject,
|
|
StoreEnhancer
|
|
} from "redux";
|
|
|
|
export interface RemoteReduxDevToolsOptions {
|
|
/** The instance name to be showed on the monitor page. */
|
|
name?: string;
|
|
/**
|
|
* Specifies whether to allow remote monitoring. By default is
|
|
* `process.env.NODE_ENV === 'development'`.
|
|
*/
|
|
realtime?: boolean;
|
|
/**
|
|
* Used to specify host for `remotedev-server`. If `port` is specified,
|
|
* default value is `localhost`.
|
|
*/
|
|
hostname?: string;
|
|
/** Used to specify host's port for `remotedev-server`. */
|
|
port?: number;
|
|
/** Specifies whether to use `https` protocol for `remotedev-server`. */
|
|
secure?: boolean;
|
|
/**
|
|
* Maximum allowed actions to be stored in the history tree. The oldest
|
|
* actions are removed once `maxAge` is reached. It's critical for
|
|
* performance.
|
|
*/
|
|
maxAge?: number;
|
|
/**
|
|
* Function which takes `action` object as argument, and should return
|
|
* `action` object back.
|
|
*/
|
|
actionSanitizer?(action: any): any;
|
|
/**
|
|
* Function which takes `state` object as argument, and should return
|
|
* `state` object back.
|
|
*/
|
|
stateSanitizer?(state: any): any;
|
|
/**
|
|
* Actions types to be hidden in the monitors (while passed to the
|
|
* reducers). If `actionsWhitelist` specified, `actionsBlacklist` is ignored.
|
|
*/
|
|
actionsBlacklist?: string | string[];
|
|
/**
|
|
* Actions types to be shown in the monitors (while passed to the reducers).
|
|
* If `actionsWhitelist` specified, `actionsBlacklist` is ignored.
|
|
*/
|
|
actionsWhitelist?: string | string[];
|
|
/**
|
|
* Action or list of actions which should start remote monitoring (when
|
|
* `realtime` is `false`).
|
|
*/
|
|
startOn?: string | string[];
|
|
/** Action or list of actions which should stop remote monitoring. */
|
|
stopOn?: string | string[];
|
|
/**
|
|
* Action or list of actions which should trigger sending the history to
|
|
* the monitor (without starting it).
|
|
*/
|
|
sendOn?: string | string[];
|
|
/**
|
|
* `0` - disabled (default)
|
|
* `1` - send all uncaught exception messages
|
|
* `2` - send only reducers error messages.
|
|
*/
|
|
sendOnError?: 0 | 1 | 2;
|
|
/**
|
|
* URL of the monitor to send the history when sendOn is triggered. By
|
|
* default is `${secure ? 'https' : 'http'}://${hostname}:${port}`.
|
|
*/
|
|
sendTo?: string;
|
|
/** Action creators functions to be available in the dispatcher. */
|
|
actionCreators?: Array<ActionCreator<any>> | ActionCreatorsMapObject;
|
|
/**
|
|
* If specified as `false`, it will not record the changes till clicking on
|
|
* *Start recording* button. Available only for Redux enhancer, for others
|
|
* use `autoPause`.
|
|
*/
|
|
shouldRecordChanges?: boolean;
|
|
/**
|
|
* If specified as `true`, it will not allow any non-monitor actions to be
|
|
* dispatched till clicking on *Unlock changes* button. Available only for
|
|
* Redux enhancer.
|
|
*/
|
|
shouldStartLocked?: boolean;
|
|
/**
|
|
* If set to `false`, will not recompute the states on hot reloading (or on
|
|
* replacing the reducers). Available only for Redux enhancer.
|
|
*/
|
|
shouldHotReload?: boolean;
|
|
/**
|
|
* If specified as `true`, whenever there's an exception in reducers, the
|
|
* monitors will show the error message, and next actions will not be
|
|
* dispatched.
|
|
*/
|
|
shouldCatchErrors?: boolean;
|
|
/**
|
|
* Identifies the instance when sending the history triggered by `sendOn`.
|
|
* You can use, for example, user id here, to know who sent the data.
|
|
*/
|
|
id?: string;
|
|
}
|
|
|
|
export function composeWithDevTools(options?: RemoteReduxDevToolsOptions): (...funcs: StoreEnhancer[]) => StoreEnhancer;
|
|
export function composeWithDevTools(...funcs: StoreEnhancer[]): StoreEnhancer;
|