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

doc: Update new crash-reporter API.

Browse source
This commit is contained in:
Cheng Zhao 2013-11-14 13:39:44 +08:00
parent 9007a45051
commit dd4e43eb02
1 changed files with 13 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
docs/api/common/crash-reporter.md
View file

@ -4,24 +4,19 @@ An example of automatically submitting crash reporters to remote server:
```javascript ```javascript
crashReporter = require('crash-reporter'); crashReporter = require('crash-reporter');
crashReporter.setProductName('YourName'); crashReporter.start({
crashReporter.setCompanyName('YourCompany'); productName: 'YourName',
crashReporter.setSubmissionUrl('https://your-domain.com/url-to-submit'); companyName: 'YourCompany',
crashReporter.setAutoSubmit(true); submitUrl: 'https://your-domain.com/url-to-submit',
autoSubmit: true
});
``` ```
## crashReporter.setProductName(product) ## crashReporter.start(options)
* `product` String * `options` Object
* `productName` String
## crashReporter.setCompanyName(company) * `companyName` String
* `submitUrl` String - URL that crash reports would be sent to
* `company` String * `autoSubmit` Boolean - Send the crash report without user interaction
* `ignoreSystemCrashHandler` Boolean
## crashReporter.setSubmissionUrl(url)
* `url` String
## crashReporter.setAutoSubmit(is)
* `is` Boolean