mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Specifiy function param types in docs

Browse source
This commit is contained in:
Samuel Attard 2016-10-13 17:30:57 +11:00
parent 7584e73d70
commit 20323e7032
No known key found for this signature in database
GPG key ID: 273DC1869D8F13EF
13 changed files with 226 additions and 133 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/api/dialog.md
View file

@ -34,6 +34,7 @@ The `dialog` module has the following methods:
contain `openFile`, `openDirectory`, `multiSelections`, `createDirectory`
and `showHiddenFiles`.
* `callback` Function (optional)
* `filePaths` String[] - An array of file paths chosen by the user
On success this method returns an array of file paths chosen by the user,
otherwise it returns `undefined`.
@ -74,6 +75,7 @@ shown.
left empty the default label will be used.
* `filters` String[]
* `callback` Function (optional)
* `filename` String
On success this method returns the path of the file chosen by the user,
otherwise it returns `undefined`.
@ -110,6 +112,7 @@ will be passed via `callback(filename)`
the style of modern Windows apps. If you don't like this behavior, you can
set `noLink` to `true`.
* `callback` Function
* `response` Number - The index of the button that was clicked
Shows a message box, it will block the process until the message box is closed.
It returns the index of the clicked button.