Skip to content

Fix docs position of shouldNotifyInNpmScript #143

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sindresorhus merged 1 commit into from
Sep 12, 2018
Merged

Fix docs position of shouldNotifyInNpmScript #143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,13 @@ Type: `Function`

Passing a callback here will make it check for an update directly and report right away. Not recommended as you won't get the benefits explained in [`How`](#how). `update` is equal to `notifier.update`.

#### shouldNotifyInNpmScript

Type: `boolean`<br>
Default: `false`

Allows notification to be shown when running as an npm script.

### notifier.notify([options])

Convenience method to display a notification message. *(See screenshot)*
Expand Down Expand Up @@ -153,12 +160,6 @@ Default: `{padding: 1, margin: 1, align: 'center', borderColor: 'yellow', border

Options object that will be passed to [`boxen`](https://github.com/sindresorhus/boxen).

##### shouldNotifyInNpmScript

Type: `boolean`<br>
Default: `false`

Allows notification to be shown when running as an npm script.

### User settings

Expand Down