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

Merge pull request #2117 from tommoor/patch-4

Browse source 
Fixed and clarified crash-reporter documentation
This commit is contained in:
Cheng Zhao 2015-07-06 09:55:50 +08:00
commit 9f0571772d
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/api/crash-reporter.md
View file

@ -1,6 +1,6 @@
# crash-reporter # crash-reporter
An example of automatically submitting crash reporters to remote server: An example of automatically submitting crash reporters to a remote server:
```javascript ```javascript
crashReporter = require('crash-reporter'); crashReporter = require('crash-reporter');
@ -24,20 +24,20 @@ crashReporter.start({
* `ignoreSystemCrashHandler` Boolean, default: false * `ignoreSystemCrashHandler` Boolean, default: false
* `extra` Object * `extra` Object
* An object you can define which content will be send along with the report. * An object you can define which content will be send along with the report.
* Only string properties are send correctly. * Only string properties are sent correctly.
* Nested objects are not supported. * Nested objects are not supported.
Developers are required to call the API before using other crashReporter APIs. Developers are required to call this method before using other crashReporter APIs.
**Note:** On OS X, electron uses a new `crashpad` client, which is different **Note:** On OS X, electron uses a new `crashpad` client, which is different
with the `breakpad` on Windows and Linux. To enable crash collection feature, with the `breakpad` on Windows and Linux. To enable crash collection feature,
you are required to call `crashReporter.start` API to initiliaze `crashpad` in you are required to call `crashReporter.start` API to initialize `crashpad` in
main process, even you only collect crash report in renderer process. main process and in each renderer process that you wish to collect crash reports.
## crashReporter.getLastCrashReport() ## crashReporter.getLastCrashReport()
Returns the date and ID of last crash report, when there was no crash report Returns the date and ID of the last crash report, when there was no crash report
sent or the crash reporter is not started, `null` will be returned. sent or the crash reporter is not started, `null` will be returned.
## crashReporter.getUploadedReports() ## crashReporter.getUploadedReports()