Skip to content

Commit b375b32

Browse files
committed
Improve README
1 parent fadc3e5 commit b375b32

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,18 @@ on the console which is very useful. Unfortunately those process errors:
1919
and
2020
[`multipleResolves`](https://nodejs.org/api/process.html#process_event_multipleresolves) making it hard to debug.
2121
- are inconvenient to [log to an external service](#custom-logging).
22-
- cannot be conditionally skipped
22+
- cannot be conditionally skipped.
2323
- are printed each time an error is repeated (except for
2424
[`warning`](https://nodejs.org/api/process.html#process_event_warning)).
2525
- are not human-friendly.
2626

27+
`log-process-errors` fixes all those issues.
28+
2729
Without `log-process-errors`:
2830

2931
![Screenshot before](docs/before.png)
3032

31-
`log-process-errors` fixes those issues:
33+
With `log-process-errors`:
3234

3335
![Screenshot after](docs/after.png)
3436

@@ -85,9 +87,9 @@ logProcessErrors(options)
8587
- [`exitOn` `{string[]}`](#process-exit): which events should trigger
8688
`process.exit(1)`. Default: `['uncaughtException']`.
8789

88-
Please see the [options full documentation](options.md).
90+
Please see the [options full documentation](docs/options.md).
8991

90-
Example:
92+
Full example:
9193

9294
<!-- eslint-disable no-empty-function -->
9395

@@ -97,7 +99,7 @@ logProcessErrors({
9799
winstonLogger[level](message)
98100
},
99101

100-
level: { multiResolves: 'debug' },
102+
level: { multipleResolves: 'debug' },
101103

102104
message(info) {},
103105

0 commit comments

Comments
 (0)