Browse Source

Update shell openExternal docs (from review)

Gabriel Handford 8 years ago
parent
commit
c78567aba6
1 changed files with 3 additions and 1 deletions
  1. 3 1
      docs/api/shell.md

+ 3 - 1
docs/api/shell.md

@@ -40,9 +40,11 @@ Open the given file in the desktop's default manner.
 * `options` Object (optional) _macOS_
   * `activate` Boolean - `true` to bring the opened application to the
     foreground. The default is `true`.
-* `callback` Function (optional) _macOS_
+* `callback` Function (optional) - If specified will perform the open asynchronously. _macOS_
+  * `opened` Boolean
 
 Returns `Boolean` - Whether an application was available to open the URL.
+If callback is specified, it will return whether it was able to initiate the open call.
 
 Open the given external protocol URL in the desktop's default manner. (For
 example, mailto: URLs in the user's default mail agent).