Improve API.md

Author: ehmicky

README.md

@@ -108,15 +108,3 @@ logProcessErrors({
   exitOn: ['uncaughtException', 'unhandledRejection'],
 })
 ```
-
-<!-- eslint-enable no-empty-function -->
-
-# Restoring default behavior
-
-Node.js default behavior can be restored by firing the function returned by
-`logProcessErrors()`.
-
-```js
-const restore = logProcessErrors(options)
-restore()
-```

docs/options.md

@@ -1,15 +1,25 @@
-# Options
+# API
 
-Options are passed as an optional object:
+## logProcessErrors([options])
+
+Initialize `log-process-errors`. Returns a function that can be fired to restore
+Node.js default behavior.
 
 <!-- eslint-disable-next-line import/newline-after-import -->
 
 ```js
 const logProcessErrors = require('log-process-errors')
-logProcessErrors(options)
+const restore = logProcessErrors(options)
+restore()
 ```
 
-## options.log `{function}`
+### options
+
+_Type_: `object`
+
+#### log
+
+_Type_: `function(message, level, event)`
 
 By default events will be logged to the console using `console.error()`,
 `console.warn()`, etc.
@@ -35,22 +45,25 @@ If logging is asynchronous, the function should return a promise (or use
 Duplicate events are only logged once (whether the `log` option is defined or
 not).
 
-## options.level `{object}`
+#### level
 
-Which log level to use. It should be an object whose:
+_Type_: `object`
 
-- keys are the event names
-  ([`uncaughtException`](https://nodejs.org/api/process.html#process_event_uncaughtexception),
-  [`warning`](https://nodejs.org/api/process.html#process_event_warning),
-  [`unhandledRejection`](https://nodejs.org/api/process.html#process_event_unhandledrejection),
-  [`rejectionHandled`](https://nodejs.org/api/process.html#process_event_rejectionhandled),
-  [`multipleResolves`](https://nodejs.org/api/process.html#process_event_multipleresolves)
-  or `default`)
-- values are the log level (`"debug"`, `"info"`, `"warn"`, `"error"`,
-  `"silent"` or `"default"`). It can also be a function using
-  [`event` as argument](#event) and returning one of those log levels.
+_Default_: `{ warning: 'warn', multipleResolves: 'info', default: 'error' }`.
+
+Which log level to use.
 
-Default: `{ warning: 'warn', multipleResolves: 'info', default: 'error' }`.
+Object keys are the event names:
+[`uncaughtException`](https://nodejs.org/api/process.html#process_event_uncaughtexception),
+[`warning`](https://nodejs.org/api/process.html#process_event_warning),
+[`unhandledRejection`](https://nodejs.org/api/process.html#process_event_unhandledrejection),
+[`rejectionHandled`](https://nodejs.org/api/process.html#process_event_rejectionhandled),
+[`multipleResolves`](https://nodejs.org/api/process.html#process_event_multipleresolves)
+or `default`.
+
+Object values are the log levelL `"debug"`, `"info"`, `"warn"`, `"error"`,
+`"silent"` or `"default"`. It can also be a function using
+[`event` as argument](#event) and returning one of those log levels.
 
 ```js
 // Use `debug` log level for `multipleResolves` instead of `info`
@@ -70,40 +83,51 @@ logProcessErrors({
 })
 ```
 
-## options.message `{function}`
+#### message
+
+_Type_: `function(level, event, options) => string`
 
-Override the default message generation. It should be a function returning a
-string and whose arguments are [`level`](#optionslevel-object),
-[`event`](#event) and [`options`](#options).
+_Default_: generate a nice-looking and descriptive log message.
 
-By default a nice-looking and descriptive log message is generated.
+Override the default message generation. Arguments are
+[`level`](#optionslevel-object), [`event`](#event) and [`options`](#options).
 
-## options.colors `{boolean}`
+#### colors
 
-Colorize the default [`options.message`](#optionsmessage-function). Default:
-`true` if the output is a terminal.
+_Type_: `boolean`
 
-## options.exitOn `{string[]}`
+_Default_: `true` if the output is a terminal.
+
+Colorize the default [`options.message`](#optionsmessage-function).
+
+#### exitOn
+
+_Type_: `string[]`
+
+_Default_: `["uncaughtException"]`
 
 Which events should trigger `process.exit(1)`:
 
-- the default value is `["uncaughtException"]`. This is the
-  [default behavior](https://nodejs.org/api/process.html#process_warning_using_uncaughtexception_correctly)
-  of Node.js.
+- `["uncaughtException"]` is Node.js
+  [default behavior](https://nodejs.org/api/process.html#process_warning_using_uncaughtexception_correctly).
 - we recommend using `["uncaughtException", "unhandledRejection"]`
-  instead since this will be the [future default behavior of Node.js](https://nodejs.org/dist/latest-v8.x/docs/api/deprecations.html#deprecations_dep0018_unhandled_promise_rejections).
+  instead since this will be [Node.js future default behavior](https://nodejs.org/dist/latest-v8.x/docs/api/deprecations.html#deprecations_dep0018_unhandled_promise_rejections).
 - to prevent any `process.exit(1)` use `[]`. Recommended if your process is
   long-running and does not automatically restart on exit.
 
 `process.exit(1)` will only be fired after successfully logging the event.
 
-# Event
+### event
+
+_Type_: `object`
 
 The [`log`](#optionslog-string), [`level`](#optionslevel-object) and
 [`message`](#optionsmessage-function) options all receive as argument an `event`
 object.
 
-## event.name
+#### event.name
+
+_Type_: `string`
 
 Can be
 [`"uncaughtException"`](https://nodejs.org/api/process.html#process_event_uncaughtexception),
@@ -113,7 +137,9 @@ Can be
 or
 [`"warning"`](https://nodejs.org/api/process.html#process_event_warning).
 
-## event.value
+#### event.value
+
+_Type_: `any` (usually an `Error` instance but not always)
 
 Value:
 
@@ -127,15 +153,14 @@ Value:
 - emitted by
   [`warning`](https://nodejs.org/api/process.html#process_event_warning).
 
-It is usually an `Error` instance but could be anything.
+#### event.rejected
 
-## event.rejected
+_Type_: `boolean`
 
-Boolean indicating whether the promise was initially resolved or rejected. Only
-defined with
+Whether the promise was initially resolved or rejected. Only defined with
 [`multipleResolves`](https://nodejs.org/api/process.html#process_event_multipleresolves).
 
-## event.nextValue, event.nextRejected
+#### event.nextValue, event.nextRejected
 
 Like [`value`](#eventvalue) and [`rejected`](#eventrejected) but for
 the second time the promise was resolved/rejected. Only defined with