Package selection guidance compiled from public package information, community data, and project usage.
Redux_logging is a middleware for Redux.dart that logs each action and the resulting state after it's processed. It helps developers debug state changes by providing real-time output of actions and their effects on the application state. Ideal for development environments, it enhances visibility into how state evolves over time. The package integrates seamlessly with existing Redux.dart setups and supports all major platforms including Android, iOS, Web, macOS, Windows, and Linux.
Use cases
Debugging state transitions
Monitoring action flow during development
Tracking state changes in complex apps
Validating reducer logic
Improving developer experience in debugging
Key features
Logs actions and state after each dispatch
Simple integration with Redux.dart
Cross-platform support
Minimal performance overhead
Configurable logging behavior
Suitable for
Developers using Redux.dart
Teams prioritizing state transparency
Applications with complex state management
Frontend developers focused on debugging
Learning or teaching Redux patterns
Considerations
Not recommended for production builds
May impact performance if logging too frequently
Requires manual configuration for advanced use
Limited to basic console output
Does not persist logs beyond runtime
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
redux_logging
Connects a Logger to a Redux Store. Can also simply print the latest state / action changes.
Logs every Action that is dispatched to the Store, along with the current State.
By default, this class does not print anything to your console or send data to a web service, such as Fabric or Sentry. It simply logs entries to a Logger instance.
If you simply want to print the latest action and state to your console / terminal, create a new LoggingMiddleware.printer() and pass it to your Store upon creation.
If you want more control over where the logged data is sent, you can listen to your Logger's onRecord Stream.
Dart Versions
Dart 1 support: 0.1.x
Dart 2 Support: 0.2.x+
Simple Printing example
If you just want an easy way to print actions to your console / terminal as they are dispatched, use the new LoggingMiddleware.printer() factory.
Note: The LoggingMiddleware needs be the LAST middleware in the list.
import"package:redux/redux.dart";
import'package:redux_logging/redux_logging.dart';
final store = newStore<int>(
(int state, dynamic action) => state + 1,
initialValue: 0,
// Note the LoggingMiddleware should come last in the list of Middleware!
middleware: [myOtherMiddleware, newLoggingMiddleware.printer()]
);
store.dispatch("Hi"); // prints {Action: "Hi", Store: 1, Timestamp: ...}
Example
If you only want to log actions to a Logger, and choose how to handle the output, use the default constructor.
import'package:logging/logging.dart';
import"package:redux/redux.dart";
import'package:redux_logging/redux_logging.dart';
// Create your own Loggerfinal logger = newLogger("Redux Logger");
// Pass it to your Middlewarefinal middleware = newLoggingMiddleware(logger: logger);
final store = newStore<int>(
(int state, dynamic action) => state + 1,
initialState: 0,
middleware: [middleware],
);
// Note: One quirk about listening to a logger instance is that you're// actually listening to the Singleton instance of *all* loggers.
logger.onRecord
// Filter down to [LogRecord]s sent to your logger instance
.where((record) => record.loggerName == logger.name)
// Print them out (or do something more interesting!)
.listen((loggingMiddlewareRecord) => print(loggingMiddlewareRecord));
Formatting the log message
This library includes two formatters out of the box:
LoggingMiddleware.singleLineFormatter
LoggingMiddleware.multiLineFormatter
You can optionally control the format of the message that will be logged by implementing your own MessageFormatter and passing it to the LoggingMiddleware constructor. It is a simple function that takes three parameters: the State, Action, and Timestamp.
Formatting Example
import"package:redux/redux.dart";
import'package:redux_logging/redux_logging.dart';
// Create a formatter that only prints out the dispatched actionString onlyLogActionFormatter<State>(
State state,
dynamic action,
DateTime timestamp,
) {
return"{Action: $action}";
}
// Create your middleware using the formatter.final middleware = newLoggingMiddleware(formatter: onlyLogActionFormatter);
// Add the middleware with your formatter to your Storefinal store = newStore<int>(
(int state, dynamic action) => state + 1,
initialState: 0,
middleware: [middleware],
);