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

docs: |options| is not optional

Browse source 
Close #3845.
This commit is contained in:
Cheng Zhao 2015-12-17 18:40:52 +08:00
parent 19835cf346
commit afedce0b18
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/api/dialog.md
View file

@ -20,10 +20,10 @@ parameter.
The `dialog` module has the following methods: The `dialog` module has the following methods:
### `dialog.showOpenDialog([browserWindow][, options][, callback])` ### `dialog.showOpenDialog([browserWindow, ]options[, callback])`
* `browserWindow` BrowserWindow (optional) * `browserWindow` BrowserWindow (optional)
* `options` Object (optional) * `options` Object
* `title` String * `title` String
* `defaultPath` String * `defaultPath` String
* `filters` Array * `filters` Array
@ -61,10 +61,10 @@ and a directory selector, so if you set `properties` to
`['openFile', 'openDirectory']` on these platforms, a directory selector will be `['openFile', 'openDirectory']` on these platforms, a directory selector will be
shown. shown.
### `dialog.showSaveDialog([browserWindow][, options][, callback])` ### `dialog.showSaveDialog([browserWindow, ]options[, callback])`
* `browserWindow` BrowserWindow (optional) * `browserWindow` BrowserWindow (optional)
* `options` Object (optional) * `options` Object
* `title` String * `title` String
* `defaultPath` String * `defaultPath` String
* `filters` Array * `filters` Array
@ -79,10 +79,10 @@ The `filters` specifies an array of file types that can be displayed, see
If a `callback` is passed, the API call will be asynchronous and the result If a `callback` is passed, the API call will be asynchronous and the result
will be passed via `callback(filename)` will be passed via `callback(filename)`
### `dialog.showMessageBox([browserWindow][, options][, callback])` ### `dialog.showMessageBox([browserWindow, ]options[, callback])`
* `browserWindow` BrowserWindow (optional) * `browserWindow` BrowserWindow (optional)
* `options` Object (optional) * `options` Object
* `type` String - Can be `"none"`, `"info"`, `"error"`, `"question"` or * `type` String - Can be `"none"`, `"info"`, `"error"`, `"question"` or
`"warning"`. On Windows, "question" displays the same icon as "info", unless `"warning"`. On Windows, "question" displays the same icon as "info", unless
you set an icon using the "icon" option. you set an icon using the "icon" option.