Options (fable-electron-docs-api)

Options Type

Namespace: Fable.Electron
Assembly: Fable.Electron.dll
Parent Module: Start
Base Type: obj

Constructors

Constructor Description

Constructor	Description
`Options(?submitURL, ?productName, ?companyName, ?uploadToServer, ?ignoreSystemCrashHandler, ?rateLimit, ?compress, ?extra, ?globalExtra)` Full Usage: `Options(?submitURL, ?productName, ?companyName, ?uploadToServer, ?ignoreSystemCrashHandler, ?rateLimit, ?compress, ?extra, ?globalExtra)` Parameters: ?submitURL : `string` - URL that crash reports will be sent to as POST. Required unless `uploadToServer` is `false`. ?productName : `string` - Defaults to `app.name`. ?companyName : `string` - Deprecated alias for `{ globalExtra: { _companyName: ... } }`. ?uploadToServer : `bool` - 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. Default is `true`. ?ignoreSystemCrashHandler : `bool` - If true, crashes generated in the main process will not be forwarded to the system crash handler. Default is `false`. ?rateLimit : `bool` - ⚠ OS Compatibility: WIN ✔ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| If true, limit the number of crashes uploaded to 1/hour. Default is `false`. ?compress : `bool` - If true, crash reports will be compressed and uploaded with `Content-Encoding: gzip`. Default is `true`. ?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 include these extra parameters. To add 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. Returns: `Options`	?submitURL : `string` URL that crash reports will be sent to as POST. Required unless `uploadToServer` is `false`. ?productName : `string` Defaults to `app.name`. ?companyName : `string` Deprecated alias for `{ globalExtra: { _companyName: ... } }`. ?uploadToServer : `bool` 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. Default is `true`. ?ignoreSystemCrashHandler : `bool` If true, crashes generated in the main process will not be forwarded to the system crash handler. Default is `false`. ?rateLimit : `bool` ⚠ OS Compatibility: WIN ✔ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| If true, limit the number of crashes uploaded to 1/hour. Default is `false`. ?compress : `bool` If true, crash reports will be compressed and uploaded with `Content-Encoding: gzip`. Default is `true`. ?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 include these extra parameters. To add 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. Returns: `Options`


                
                  
                    
                      Options(?submitURL, ?productName, ?companyName, ?uploadToServer, ?ignoreSystemCrashHandler, ?rateLimit, ?compress, ?extra, ?globalExtra)

Full Usage:

Options(?submitURL, ?productName, ?companyName, ?uploadToServer, ?ignoreSystemCrashHandler, ?rateLimit, ?compress, ?extra, ?globalExtra)

Parameters:

?submitURL : string - URL that crash reports will be sent to as POST. Required unless uploadToServer is false.

?productName : string - Defaults to app.name.

?companyName : string - Deprecated alias for { globalExtra: { _companyName: ... } }.

?uploadToServer : bool - 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. Default is true.

?ignoreSystemCrashHandler : bool - If true, crashes generated in the main process will not be forwarded to the system crash handler. Default is false.

?rateLimit : bool - ⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ || If true, limit the number of crashes uploaded to 1/hour. Default is false.

?compress : bool - If true, crash reports will be compressed and uploaded with Content-Encoding: gzip. Default is true.

?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 include these extra parameters. To add 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.

Returns: Options

?submitURL : string: URL that crash reports will be sent to as POST. Required unless uploadToServer is false.
?productName : string: Defaults to app.name.
?companyName : string: Deprecated alias for { globalExtra: { _companyName: ... } }.
?uploadToServer : bool: 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. Default is true.
?ignoreSystemCrashHandler : bool: If true, crashes generated in the main process will not be forwarded to the system crash handler. Default is false.
?rateLimit : bool: ⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ || If true, limit the number of crashes uploaded to 1/hour. Default is false.
?compress : bool: If true, crash reports will be compressed and uploaded with Content-Encoding: gzip. Default is true.
?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 include these extra parameters. To add 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.

Returns: Options

Instance members

Instance member	Description
`this.compress` Full Usage: `this.compress`	If true, crash reports will be compressed and uploaded with Content-Encoding: gzip. Default is true.
`this.extra` Full Usage: `this.extra`	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 include these extra parameters. To add extra parameters to crash reports generated from child processes, call addExtraParameter from the child process.
`this.globalExtra` Full Usage: `this.globalExtra`	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.
`this.ignoreSystemCrashHandler` Full Usage: `this.ignoreSystemCrashHandler`	If true, crashes generated in the main process will not be forwarded to the system crash handler. Default is false.
`this.productName` Full Usage: `this.productName`	Defaults to app.name.
`this.rateLimit` Full Usage: `this.rateLimit`	⚠ OS Compatibility: WIN ✔ \| MAC ✔ \| LIN ❌ \| MAS ❌ If true, limit the number of crashes uploaded to 1/hour. Default is false.
`this.submitURL` Full Usage: `this.submitURL`	URL that crash reports will be sent to as POST. Required unless uploadToServer is false.
`this.uploadToServer` Full Usage: `this.uploadToServer`	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. Default is true.