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.
If you just want an easy way to print actions to your console / terminal as they are dispatched, use the new LoggingMiddleware.printer()
factory.
import "package:redux/redux.dart";
import 'package:redux_logging/redux_logging.dart';
final store = new Store<int>(
(int state, dynamic action) => state + 1,
initialValue: 0,
middleware: [new LoggingMiddleware.printer()]
);
store.dispatch("Hi"); // prints {Action: "Hi", Store: 1, Timestamp: ...}
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 Logger
final logger = new Logger("Redux Logger");
// Pass it to your Middleware
final middleware = new LoggingMiddleware(logger: logger);
final store = new Store<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));
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.
import "package:redux/redux.dart";
import 'package:redux_logging/redux_logging.dart';
// Create a formatter that only prints out the dispatched action
String onlyLogActionFormatter<State>(
State state,
dynamic action,
DateTime timestamp,
) {
return "{Action: $action}";
}
// Create your middleware using the formatter.
final middleware = new LoggingMiddleware(formatter: onlyLogActionFormatter);
// Add the middleware with your formatter to your Store
final store = new Store<int>(
(int state, dynamic action) => state + 1,
initialState: 0,
middleware: [middleware],
);
pubspec.yaml
LoggingMiddleware
for Redux, which connects the dispatched actions to to a Logger
. printer
factory, which prints all logged messages to the your console / terminal.Add this to your package's pubspec.yaml file:
dependencies:
redux_logging: ^0.3.0
You can install packages from the command line:
with pub:
$ pub get
with Flutter:
$ flutter packages get
Alternatively, your editor might support pub get
or flutter packages get
.
Check the docs for your editor to learn more.
Now in your Dart code, you can use:
import 'package:redux_logging/redux_logging.dart';
Version | Uploaded | Documentation | Archive |
---|---|---|---|
0.3.0 | Mar 30, 2018 |
|
|
0.2.0 | Mar 20, 2018 |
|
|
0.1.4 | Nov 26, 2017 |
|
|
0.1.3 | Nov 25, 2017 |
|
|
0.1.2 | Sep 7, 2017 |
|
|
0.1.1 | Aug 27, 2017 |
|
|
0.1.0 | Aug 27, 2017 |
|
|
Popularity:
Describes how popular the package is relative to other packages.
[more]
|
96
|
Health:
Code health derived from static analysis.
[more]
|
100
|
Maintenance:
Reflects how tidy and up-to-date the package is.
[more]
|
89
|
Overall:
Weighted score of the above.
[more]
|
96
|
We analyzed this package on Feb 14, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
Detected platforms: Flutter, web, other
No platform restriction found in primary library
package:redux_logging/redux_logging.dart
.
Maintain an example. (-10 points)
Create a short demo in the example/
directory to show how to use this package.
Common filename patterns include main.dart
, example.dart
, and redux_logging.dart
. Packages with multiple examples should provide example/README.md
.
For more information see the pub package layout conventions.
The package description is too short. (-1 points)
Add more detail to the description
field of pubspec.yaml
. Use 60 to 180 characters to describe the package, what it does, and its target use case.