github/atom
1
1
Fork 0
mirror of https://github.com/atom/atom.git synced 2026-01-23 22:08:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

📝 Document that NotficationManager add* methods return a Notification

Browse Source 
Parts of the Atom ecosystem rely on the fact that these methods return
the Notification that was added. For example:

https://github.com/atom/exception-reporting/blob/4e6866c3a9/lib/reporter.js#L159

Therefore, we should document that these methods are expected to return
the Notification that was added.
This commit is contained in:
Jason Rudolph
2017-09-17 08:25:05 -04:00
parent 0054e3f796
commit 9d0ed6da52
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/notification-manager.js
View File

@@ -53,6 +53,8 @@ class NotificationManager {
// notification can be dismissed by the user. Defaults to `false`.
// * `icon` (optional) A {String} name of an icon from Octicons to display
// in the notification header. Defaults to `'check'`.
//
// Returns the {Notification} that was added.
addSuccess (message, options) {
return this.addNotification(new Notification('success', message, options))
}
@@ -79,6 +81,8 @@ class NotificationManager {
// notification can be dismissed by the user. Defaults to `false`.
// * `icon` (optional) A {String} name of an icon from Octicons to display
// in the notification header. Defaults to `'info'`.
//
// Returns the {Notification} that was added.
addInfo (message, options) {
return this.addNotification(new Notification('info', message, options))
}
@@ -105,6 +109,8 @@ class NotificationManager {
// notification can be dismissed by the user. Defaults to `false`.
// * `icon` (optional) A {String} name of an icon from Octicons to display
// in the notification header. Defaults to `'alert'`.
//
// Returns the {Notification} that was added.
addWarning (message, options) {
return this.addNotification(new Notification('warning', message, options))
}
@@ -133,6 +139,8 @@ class NotificationManager {
// in the notification header. Defaults to `'flame'`.
// * `stack` (optional) A preformatted {String} with stack trace
// information describing the location of the error.
//
// Returns the {Notification} that was added.
addError (message, options) {
return this.addNotification(new Notification('error', message, options))
}
@@ -161,6 +169,8 @@ class NotificationManager {
// in the notification header. Defaults to `'bug'`.
// * `stack` (optional) A preformatted {String} with stack trace
// information describing the location of the error.
//
// Returns the {Notification} that was added.
addFatalError (message, options) {
return this.addNotification(new Notification('fatal', message, options))
}