UNPKG

2.73 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/redux-logger`
3
4# Summary
5This package contains type definitions for redux-logger (https://github.com/theaqua/redux-logger).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redux-logger.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/redux-logger/index.d.ts)
10````ts
11export as namespace ReduxLogger;
12
13import * as Redux from "redux";
14
15export const logger: Redux.Middleware;
16
17export type LoggerPredicate = (
18 getState: () => any,
19 action: any,
20 logEntry?: LogEntryObject,
21) => boolean;
22
23export type StateToString = (state: any) => string;
24export type ActionToString = (action: any) => string;
25export type ErrorToString = (error: any, prevState: any) => string;
26
27export interface ColorsObject {
28 title?: boolean | ActionToString | undefined;
29 prevState?: boolean | StateToString | undefined;
30 action?: boolean | ActionToString | undefined;
31 nextState?: boolean | StateToString | undefined;
32 error?: boolean | ErrorToString | undefined;
33}
34
35export interface LevelObject {
36 prevState?: string | boolean | StateToString | undefined;
37 action?: string | boolean | ActionToString | undefined;
38 nextState?: string | boolean | StateToString | undefined;
39 error?: string | boolean | ErrorToString | undefined;
40}
41
42export interface LogEntryObject {
43 action?: string | boolean | ActionToString | undefined;
44 started?: number | undefined;
45 startedTime?: Date | undefined;
46 took?: number | undefined;
47 error?(error: any): any;
48 nextState?(state: any): any;
49 prevState?(state: any): any;
50}
51
52export interface ReduxLoggerOptions {
53 level?: string | ActionToString | LevelObject | undefined;
54 duration?: boolean | undefined;
55 timestamp?: boolean | undefined;
56 colors?: ColorsObject | false | undefined;
57 titleFormatter?(formattedAction: any, formattedTime: string, took: number): string;
58 logger?: any;
59 logErrors?: boolean | undefined;
60 collapsed?: boolean | LoggerPredicate | undefined;
61 predicate?: LoggerPredicate | undefined;
62 diff?: boolean | undefined;
63 diffPredicate?: LoggerPredicate | undefined;
64 stateTransformer?(state: any): any;
65 actionTransformer?(action: any): any;
66 errorTransformer?(error: any): any;
67}
68
69export function createLogger(options?: ReduxLoggerOptions): Redux.Middleware;
70
71export default logger;
72
73````
74
75### Additional Details
76 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
77 * Dependencies: [redux](https://npmjs.com/package/redux)
78
79# Credits
80These definitions were written by [Alexander Rusakov](https://github.com/arusakov), and [Kevin Groat](https://github.com/kgroat).
81
\No newline at end of file