ElectronCrashReporterStartOptions

Unofficial

Options for crashReporter.start.

Import:

import type { ElectronCrashReporterStartOptions } from '@obsidian-typings/obsidian-catalyst-latest';

Signature:

export interface ElectronCrashReporterStartOptions

Properties

Property	Type	Description
companyName?	string	Deprecated alias for `{ globalExtra: { _companyName: ... } }`.
compress?	boolean	If `true`, crash reports will be compressed and uploaded with `Content-Encoding: gzip`.
extra?	Record<string, string>	Extra string key/value annotations that will be sent along with crash reports that are generated in the main process. Only string values are supported. Crashes generated in child processes will not contain these extra parameters to crash reports generated from child processes, call `addExtraParameter` from the child process.
globalExtra?	Record<string, string>	Extra string key/value annotations that will be sent along with any crash reports generated in any process. These annotations cannot be changed once the crash reporter has been started. If a key is present in both the global extra parameters and the process-specific extra parameters, then the global one will take precedence. By default, `productName` and the app version are included, as well as the Electron version.
ignoreSystemCrashHandler?	boolean	If `true`, crashes generated in the main process will not be forwarded to the system crash handler.
productName?	string	The name of the product, defaulting to `app.name`.
rateLimit?	boolean	If `true`, limit the number of crashes uploaded to 1/hour.
submitURL?	string	URL that crash reports will be sent to as POST. Required unless `uploadToServer` is `false`.
uploadToServer?	boolean	Whether crash reports should be sent to the server. If `false`, crash reports will be collected and stored in the crashes directory, but not uploaded.