Merge pull request #14132 from electron/fix-crashreporter-arg

docs: crashReporter companyName is not optional
This commit is contained in:
John Kleinschmidt 2018-08-16 09:22:16 -07:00 committed by GitHub
commit 74426ad45e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -42,7 +42,7 @@ The `crashReporter` module has the following methods:
### `crashReporter.start(options)` ### `crashReporter.start(options)`
* `options` Object * `options` Object
* `companyName` String (optional) * `companyName` String
* `submitURL` String - URL that crash reports will be sent to as POST. * `submitURL` String - URL that crash reports will be sent to as POST.
* `productName` String (optional) - Defaults to `app.getName()`. * `productName` String (optional) - Defaults to `app.getName()`.
* `uploadToServer` Boolean (optional) - Whether crash reports should be sent to the server * `uploadToServer` Boolean (optional) - Whether crash reports should be sent to the server