Browse Source

Make crashesDirectory optional

Samuel Attard 7 years ago
parent
commit
195cb91721
1 changed files with 1 additions and 1 deletions
  1. 1 1
      docs/api/crash-reporter.md

+ 1 - 1
docs/api/crash-reporter.md

@@ -46,7 +46,7 @@ The `crashReporter` module has the following methods:
   * `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.
-  * `crashesDirectory` String - Directory to store the crashreports temporarily (only used when the crash reporter is started via `process.crashReporter.start`)
+  * `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
 and in each process (main/renderer) from which you want to collect crash reports.