Browse Source

docs: add return type for subscribeNotification (#15500)

trop[bot] 6 years ago
parent
commit
deac580f1a
1 changed files with 4 additions and 0 deletions
  1. 4 0
      docs/api/system-preferences.md

+ 4 - 0
docs/api/system-preferences.md

@@ -83,6 +83,8 @@ that contains the user information dictionary sent along with the notification.
 * `callback` Function
   * `event` String
   * `userInfo` Object
+  
+Returns `Number` - The ID of this subscription
 
 Subscribes to native notifications of macOS, `callback` will be called with
 `callback(event, userInfo)` when the corresponding `event` happens. The
@@ -106,6 +108,8 @@ example values of `event` are:
 * `callback` Function
   * `event` String
   * `userInfo` Object
+  
+Returns `Number` - The ID of this subscription
 
 Same as `subscribeNotification`, but uses `NSNotificationCenter` for local defaults.
 This is necessary for events such as `NSUserDefaultsDidChangeNotification`.