Table of contents

Install

Usage

import{applyMiddleware,createStore}from'redux';// Logger with default optionsimportloggerfrom'redux-logger'conststore=createStore(reducer,applyMiddleware(logger))// Note passing middleware as the third argument requires redux@>=3.1.0

import{applyMiddleware,createStore}from'redux';import{createLogger}from'redux-logger'constlogger=createLogger({// ...options});conststore=createStore(reducer,applyMiddleware(logger));

Options

{predicate,// if specified this function will be called before each action is processed with this middleware.collapsed,// takes a Boolean or optionally a Function that receives `getState` function for accessing current store state and `action` object as parameters. Returns `true` if the log group should be collapsed, `false` otherwise.duration=false:Boolean,// print the duration of each action?timestamp=true:Boolean,// print the timestamp with each action?level='log':'log'|'console'|'warn'|'error'|'info',// console's levelcolors:ColorsObject,// colors for title, prev state, action and next state: https://github.com/evgenyrodionov/redux-logger/blob/master/src/defaults.js#L12-L18titleFormatter,// Format the title used when logging actions.stateTransformer,// Transform state before print. Eg. convert Immutable object to plain JSON.actionTransformer,// Transform action before print. Eg. convert Immutable object to plain JSON.errorTransformer,// Transform error before print. Eg. convert Immutable object to plain JSON.logger=console:LoggerObject,// implementation of the `console` API.logErrors=true:Boolean,// should the logger catch, log, and re-throw errors?diff=false:Boolean,// (alpha) show diff between states?diffPredicate// (alpha) filter function for showing states diff, similar to `predicate`}

Options description

level (String | Function | Object)

duration (Boolean)

timestamp (Boolean)

colors (Object)

logger (Object)

logErrors (Boolean)

collapsed = (getState: Function, action: Object, logEntry: Object) => Boolean

predicate = (getState: Function, action: Object) => Boolean

stateTransformer = (state: Object) => state

actionTransformer = (action: Object) => action

errorTransformer = (error: Any) => error

titleFormatter = (action: Object, time: String?, took: Number?) => title

diff (Boolean)

diffPredicate = (getState: Function, action: Object) => Boolean

Recipes

Log only in development

constmiddlewares=[];if(process.env.NODE_ENV===`development`){const{ logger}=require(`redux-logger`);middlewares.push(logger);}conststore=compose(applyMiddleware(...middlewares))(createStore)(reducer);

Log everything except actions with certain type

createLogger({predicate:(getState,action)=>action.type!==AUTH_REMOVE_TOKEN});

Collapse actions with certain type

createLogger({collapsed:(getState,action)=>action.type===FORM_CHANGE});

Collapse actions that don't have errors

createLogger({collapsed:(getState,action,logEntry)=>!logEntry.error});

Transform Immutable (withoutcombineReducers)

import{Iterable}from'immutable';conststateTransformer=(state)=>{if(Iterable.isIterable(state))returnstate.toJS();elsereturnstate;};constlogger=createLogger({  stateTransformer,});

Transform Immutable (withcombineReducers)

constlogger=createLogger({stateTransformer:(state)=>{letnewState={};for(variofObject.keys(state)){if(Immutable.Iterable.isIterable(state[i])){newState[i]=state[i].toJS();}else{newState[i]=state[i];}};returnnewState;}});

Log batched actions

import{createLogger}from'redux-logger';constactionTransformer=action=>{if(action.type==='BATCHING_REDUCER.BATCH'){action.payload.type=action.payload.map(next=>next.type).join(' => ');returnaction.payload;}returnaction;};constlevel='info';constlogger={};for(constmethodinconsole){if(typeofconsole[method]==='function'){logger[method]=console[method].bind(console);}}logger[level]=functionlevelFn(...args){constlastArg=args.pop();if(Array.isArray(lastArg)){returnlastArg.forEach(item=>{console[level].apply(console,[...args,item]);});}console[level].apply(console,arguments);};exportdefaultcreateLogger({  level,  actionTransformer,  logger});

To Do

Known issues

License