Browse Source

docs: clarify crash report extra param length (#18386)

Resolves #17746.

Clarifies that the extra field of the crashReporter options object only needs to be < 64 characters on Windows.
Shelley Vohr 5 years ago
parent
commit
01cd6e7a06
1 changed files with 2 additions and 3 deletions
  1. 2 3
      docs/api/crash-reporter.md

+ 2 - 3
docs/api/crash-reporter.md

@@ -46,12 +46,11 @@ The `crashReporter` module has the following methods:
   * `companyName` String
   * `submitURL` String - URL that crash reports will be sent to as POST.
   * `productName` String (optional) - Defaults to `app.name`.
-  * `uploadToServer` Boolean (optional) - Whether crash reports should be sent to the server
-    Default is `true`.
+  * `uploadToServer` Boolean (optional) - Whether crash reports should be sent to the server. Default is `true`.
   * `ignoreSystemCrashHandler` Boolean (optional) - Default is `false`.
   * `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
-    supported and the property names and values must be less than 64 characters long.
+    supported. When using Windows, the property names and values must be fewer than 64 characters.
   * `crashesDirectory` String (optional) - Directory to store the crashreports temporarily (only used when the crash reporter is started via `process.crashReporter.start`).
 
 You are required to call this method before using any other `crashReporter` APIs