Options (fable-electron-docs-api)

Options Type

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

Constructors

Constructor Description

Constructor	Description
`Options(?env, ?execArgv, ?cwd, ?stdio, ?serviceName, ?allowLoadingUnsignedLibraries, ?respondToAuthRequestsFromMainProcess)` Full Usage: `Options(?env, ?execArgv, ?cwd, ?stdio, ?serviceName, ?allowLoadingUnsignedLibraries, ?respondToAuthRequestsFromMainProcess)` Parameters: ?env : `obj` - Environment key-value pairs. Default is `process.env`. ?execArgv : `string[]` - List of string arguments passed to the executable. ?cwd : `string` - Current working directory of the child process. ?stdio : `U2<Stdio[], string>` - Allows configuring the mode for `stdout` and `stderr` of the child process. Default is `inherit`. String value can be one of `pipe`, `ignore`, `inherit`, for more details on these values you can refer to stdio documentation from Node.js. Currently this option only supports configuring `stdout` and `stderr` to either `pipe`, `inherit` or `ignore`. Configuring `stdin` to any property other than `ignore` is not supported and will result in an error. For example, the supported values will be processed as following: ?serviceName : `string` - Name of the process that will appear in `name` property of `ProcessMetric` returned by `app.getAppMetrics` and `child-process-gone` event of `app`. Default is `Node Utility Process`. ?allowLoadingUnsignedLibraries : `bool` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| With this flag, the utility process will be launched via the `Electron Helper (Plugin).app` helper executable on macOS, which can be codesigned with `com.apple.security.cs.disable-library-validation` and `com.apple.security.cs.allow-unsigned-executable-memory` entitlements. This will allow the utility process to load unsigned libraries. Unless you specifically need this capability, it is best to leave this disabled. Default is `false`. ?respondToAuthRequestsFromMainProcess : `bool` - With this flag, all HTTP 401 and 407 network requests created via the net module will allow responding to them via the `app#login` event in the main process instead of the default `login` event on the `ClientRequest` object. Default is `false`. Returns: `Options`	?env : `obj` Environment key-value pairs. Default is `process.env`. ?execArgv : `string[]` List of string arguments passed to the executable. ?cwd : `string` Current working directory of the child process. ?stdio : `U2<Stdio[], string>` Allows configuring the mode for `stdout` and `stderr` of the child process. Default is `inherit`. String value can be one of `pipe`, `ignore`, `inherit`, for more details on these values you can refer to stdio documentation from Node.js. Currently this option only supports configuring `stdout` and `stderr` to either `pipe`, `inherit` or `ignore`. Configuring `stdin` to any property other than `ignore` is not supported and will result in an error. For example, the supported values will be processed as following: ?serviceName : `string` Name of the process that will appear in `name` property of `ProcessMetric` returned by `app.getAppMetrics` and `child-process-gone` event of `app`. Default is `Node Utility Process`. ?allowLoadingUnsignedLibraries : `bool` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| With this flag, the utility process will be launched via the `Electron Helper (Plugin).app` helper executable on macOS, which can be codesigned with `com.apple.security.cs.disable-library-validation` and `com.apple.security.cs.allow-unsigned-executable-memory` entitlements. This will allow the utility process to load unsigned libraries. Unless you specifically need this capability, it is best to leave this disabled. Default is `false`. ?respondToAuthRequestsFromMainProcess : `bool` With this flag, all HTTP 401 and 407 network requests created via the net module will allow responding to them via the `app#login` event in the main process instead of the default `login` event on the `ClientRequest` object. Default is `false`. Returns: `Options`


                
                  
                    
                      Options(?env, ?execArgv, ?cwd, ?stdio, ?serviceName, ?allowLoadingUnsignedLibraries, ?respondToAuthRequestsFromMainProcess)

Full Usage:

Options(?env, ?execArgv, ?cwd, ?stdio, ?serviceName, ?allowLoadingUnsignedLibraries, ?respondToAuthRequestsFromMainProcess)

Parameters:

?env : obj - Environment key-value pairs. Default is process.env.

?execArgv : string[] - List of string arguments passed to the executable.

?cwd : string - Current working directory of the child process.

?stdio : U2<Stdio[], string> - Allows configuring the mode for stdout and stderr of the child process. Default is inherit. String value can be one of pipe, ignore, inherit, for more details on these values you can refer to stdio documentation from Node.js. Currently this option only supports configuring stdout and stderr to either pipe, inherit or ignore. Configuring stdin to any property other than ignore is not supported and will result in an error. For example, the supported values will be processed as following:

?serviceName : string - Name of the process that will appear in name property of ProcessMetric returned by app.getAppMetrics and child-process-gone event of app. Default is Node Utility Process.

?allowLoadingUnsignedLibraries : bool - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || With this flag, the utility process will be launched via the Electron Helper (Plugin).app helper executable on macOS, which can be codesigned with com.apple.security.cs.disable-library-validation and com.apple.security.cs.allow-unsigned-executable-memory entitlements. This will allow the utility process to load unsigned libraries. Unless you specifically need this capability, it is best to leave this disabled. Default is false.

?respondToAuthRequestsFromMainProcess : bool - With this flag, all HTTP 401 and 407 network requests created via the net module will allow responding to them via the app#login event in the main process instead of the default login event on the ClientRequest object. Default is false.

Returns: Options

?env : obj: Environment key-value pairs. Default is process.env.
?execArgv : string[]: List of string arguments passed to the executable.
?cwd : string: Current working directory of the child process.
?stdio : U2<Stdio[], string>: Allows configuring the mode for stdout and stderr of the child process. Default is inherit. String value can be one of pipe, ignore, inherit, for more details on these values you can refer to stdio documentation from Node.js. Currently this option only supports configuring stdout and stderr to either pipe, inherit or ignore. Configuring stdin to any property other than ignore is not supported and will result in an error. For example, the supported values will be processed as following:
?serviceName : string: Name of the process that will appear in name property of ProcessMetric returned by app.getAppMetrics and child-process-gone event of app. Default is Node Utility Process.
?allowLoadingUnsignedLibraries : bool: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || With this flag, the utility process will be launched via the Electron Helper (Plugin).app helper executable on macOS, which can be codesigned with com.apple.security.cs.disable-library-validation and com.apple.security.cs.allow-unsigned-executable-memory entitlements. This will allow the utility process to load unsigned libraries. Unless you specifically need this capability, it is best to leave this disabled. Default is false.
?respondToAuthRequestsFromMainProcess : bool: With this flag, all HTTP 401 and 407 network requests created via the net module will allow responding to them via the app#login event in the main process instead of the default login event on the ClientRequest object. Default is false.

Returns: Options

Instance members

Instance member	Description
`this.allowLoadingUnsignedLibraries` Full Usage: `this.allowLoadingUnsignedLibraries`	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ With this flag, the utility process will be launched via the Electron Helper (Plugin).app helper executable on macOS, which can be codesigned with com.apple.security.cs.disable-library-validation and com.apple.security.cs.allow-unsigned-executable-memory entitlements. This will allow the utility process to load unsigned libraries. Unless you specifically need this capability, it is best to leave this disabled. Default is false.
`this.cwd` Full Usage: `this.cwd`	Current working directory of the child process.
`this.env` Full Usage: `this.env`	Environment key-value pairs. Default is process.env.
`this.execArgv` Full Usage: `this.execArgv`	List of string arguments passed to the executable.
`this.respondToAuthRequestsFromMainProcess` Full Usage: `this.respondToAuthRequestsFromMainProcess`	With this flag, all HTTP 401 and 407 network requests created via the net module will allow responding to them via the app#login event in the main process instead of the default login event on the ClientRequest object. Default is false.
`this.serviceName` Full Usage: `this.serviceName`	Name of the process that will appear in name property of ProcessMetric returned by app.getAppMetrics and child-process-gone event of app. Default is Node Utility Process.
`this.stdio` Full Usage: `this.stdio`	Allows configuring the mode for stdout and stderr of the child process. Default is inherit. String value can be one of pipe, ignore, inherit, for more details on these values you can refer to stdio documentation from Node.js. Currently this option only supports configuring stdout and stderr to either pipe, inherit or ignore. Configuring stdin to any property other than ignore is not supported and will result in an error. For example, the supported values will be processed as following: