Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
mhkeller committed Mar 25, 2023
1 parent dee2d5e commit 655b01f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Pass an object to the `notify` function with the following options:

* `m` — `{String}` The message.
* `v` — `{String}` The value.
* `d` — `{String|String[]|Object}` Display options. The most common usage of this is to supply one or more [chalk styles](https://github.com/chalk/chalk). See [advanced styling](#advanced-styling) below for more options.
* `d` — `{String|String[]|Object}` Display options. The display style. Can be a [chalk styles](https://github.com/chalk/chalk) name, array of chalk styles, the name of a built-in display, or a full display config. See [advanced styling](#advanced-styling) below for more information.
* `k` — `{Boolean}` [false] Whether to show a desktop notification using [node-notifier](https://github.com/mikaelbr/node-notifier)
* `error` — `{Error}` Pass an error object to get printed out with `console.error` for reference.

Expand Down Expand Up @@ -114,7 +114,7 @@ Here's the full list of built-in display names:

## Advanced styling

You can also pass an object to the `d` key. Here are the defalt options:
You can also pass a display config object to the `d` key. Here are the default options:

```js
{
Expand Down
2 changes: 1 addition & 1 deletion src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import isObject from './utils/isObject.js';
@param {Object} notification Settings
@param {String} notification.m A description
@param {String} notification.v A specific value
@param {String|Array|Object} notification.d The display value. Can be a chalk color name, array of them, or a display object with more settings
@param {String|Array|Object} notification.d The display style. Can be a chalk style name, array of chalk styles, the name of a built-in display, or a full display config
@param {Object} [notification.error] An optional error object to log out
@param {Boolean} [notification.k = false] Send a desktop notification
*/
Expand Down

0 comments on commit 655b01f

Please sign in to comment.