Browse Source

docs: add return type for subscribeNotification (#15490)

Samuel Attard 6 years ago
parent
commit
86064a7bd8
1 changed files with 4 additions and 0 deletions
  1. 4 0
      docs/api/system-preferences.md

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

@@ -89,6 +89,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
@@ -112,6 +114,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`.