Skip to content

Commit

Permalink
Update to best practices in README
Browse files Browse the repository at this point in the history
- Omit `new`.
- Avoid an inferrable type on the listener function literal.
- Avoid reduntant type when intializing logger.
- Don't abbreviate "record".
- Reflow to 80 characters.
- Change the `[]` which were not links to backticks.
  • Loading branch information
natebosch committed Sep 20, 2018
1 parent 79978e5 commit a8c206f
Showing 1 changed file with 16 additions and 18 deletions.
34 changes: 16 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,31 @@
## Initializing

By default, the logging package does not do anything useful with the
log messages. You must configure the logging level and add a handler
for the log messages.
By default, the logging package does not do anything useful with the log
messages. You must configure the logging level and add a handler for the log
messages.

Here is a simple logging configuration that logs all messages
via `print`.
Here is a simple logging configuration that logs all messages via `print`.

```dart
Logger.root.level = Level.ALL;
Logger.root.onRecord.listen((LogRecord rec) {
print('${rec.level.name}: ${rec.time}: ${rec.message}');
Logger.root.onRecord.listen((record) {
print('${record.level.name}: ${record.time}: ${record.message}');
});
```

First, set the root [Level]. All messages at or above the level are
sent to the [onRecord] stream.
First, set the root `Level`. All messages at or above the level are sent to the
`onRecord` stream.

Then, listen on the [onRecord] stream for [LogRecord] events. The
[LogRecord] class has various properties for the message, error,
logger name, and more.
Then, listen on the `onRecord` stream for `LogRecord` events. The `LogRecord`
class has various properties for the message, error, logger name, and more.

## Logging messages

Create a [Logger] with a unique name to easily identify the source
of the log messages.
Create a `Logger` with a unique name to easily identify the source of the log
messages.

```dart
final Logger log = new Logger('MyClassName');
final log = Logger('MyClassName');
```

Here is an example of logging a debug message and an error:
Expand All @@ -39,11 +37,11 @@ var future = doSomethingAsync().then((result) {
}).catchError((e, stackTrace) => log.severe('Oh noes!', e, stackTrace));
```

When logging more complex messages, you can pass a closure instead
that will be evaluated only if the message is actually logged:
When logging more complex messages, you can pass a closure instead that will be
evaluated only if the message is actually logged:

```dart
log.fine(() => [1, 2, 3, 4, 5].map((e) => e * 4).join("-"));
```

See the [Logger] class for the different logging methods.
See the `Logger` class for the different logging methods.

0 comments on commit a8c206f

Please sign in to comment.