You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
Copy file name to clipboardexpand all lines: readme.md
+15-25
Original file line number
Diff line number
Diff line change
@@ -80,21 +80,6 @@ The update check is done in a unref'ed [child process](https://nodejs.org/api/ch
80
80
The first time the user runs your app, it will check for an update, and even if an update is available, it will wait the specified `updateCheckInterval` before notifying the user. This is done to not be annoying to the user, but might surprise you as an implementer if you're testing whether it works. Check out [`example.js`](example.js) to quickly test out `update-notifier` and see how you can test that it works in your app.
81
81
82
82
83
-
---
84
-
85
-
<divalign="center">
86
-
<b>
87
-
<a href="https://tidelift.com/subscription/pkg/npm-update_notifier?utm_source=npm-update-notifier&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
88
-
</b>
89
-
<br>
90
-
<sub>
91
-
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
92
-
</sub>
93
-
</div>
94
-
95
-
---
96
-
97
-
98
83
## API
99
84
100
85
### notifier = updateNotifier(options)
@@ -103,9 +88,11 @@ Checks if there is an available update. Accepts options defined below. Returns a
103
88
104
89
### options
105
90
91
+
Type: `object`
92
+
106
93
#### pkg
107
94
108
-
Type: `Object`
95
+
Type: `object`
109
96
110
97
##### name
111
98
@@ -152,7 +139,7 @@ Only notifies if there is an update and the process is [TTY](https://nodejs.org/
152
139
153
140
#### options
154
141
155
-
Type: `Object`
142
+
Type: `object`
156
143
157
144
##### defer
158
145
@@ -177,7 +164,7 @@ Include the `-g` argument in the default message's `npm i` recommendation. You m
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure.
<a href="https://tidelift.com/subscription/pkg/npm-update_notifier?utm_source=npm-update-notifier&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
206
+
</b>
207
+
<br>
208
+
<sub>
209
+
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
0 commit comments