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

Tweak character limit description

Browse source
This commit is contained in:
Kevin Sawicki 2017-06-26 08:35:57 -07:00 • committed by GitHub
parent 4bed743417
commit cbaf3d4787
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -45,7 +45,7 @@ The `crashReporter` module has the following methods:
* `ignoreSystemCrashHandler` Boolean (optional) - Default is `false`. * `ignoreSystemCrashHandler` Boolean (optional) - Default is `false`.
* `extra` Object (optional) - An object you can define that will be sent along with the * `extra` Object (optional) - An object you can define that will be sent along with the
report. Only string properties are sent correctly. Nested objects are not report. Only string properties are sent correctly. Nested objects are not
supported. The property name and the value must be less than 63 characters. supported and the property names and values must be less than 64 characters long.
You are required to call this method before using any other `crashReporter` APIs You are required to call this method before using any other `crashReporter` APIs
and in each process (main/renderer) from which you want to collect crash reports. and in each process (main/renderer) from which you want to collect crash reports.
@ -117,9 +117,10 @@ called before `start` is called.
### `crashReporter.setExtraParameter(key, value)` _macOS_ ### `crashReporter.setExtraParameter(key, value)` _macOS_
* `key` String - Max length 63 - Parameter key. * `key` String - Parameter key, must be less than 64 characters long.
* `value` String - Max length 63 - Parameter value. Specifying `null` or `undefined` will * `value` String - Parameter value, must be less than 64 characters long.
remove the key from the extra parameters. Specifying `null` or `undefined` will remove the key from the extra
parameters.
Set an extra parameter to set be sent with the crash report. The values Set an extra parameter to set be sent with the crash report. The values
specified here will be sent in addition to any values set via the `extra` option specified here will be sent in addition to any values set via the `extra` option