Class for managing IEDriver specific options.

Hierarchy

Constructors

Methods

  • Returns {}

    The JSON representation of this instance. Note, the returned object may contain nested promised values.

      Suppress

      Suppress [] access on a struct (state inherited from Map).

    • Specifies command-line switches to use when launching Internet Explorer. This is only valid when used with #forceCreateProcessApi.

      Parameters

      • Rest ...var_args: string[]

        The arguments to add.

      Returns Options

      A self reference.

    • Configures the timeout, in milliseconds, that the driver will attempt to located and attach to a newly opened instance of Internet Explorer. The default is zero, which indicates waiting indefinitely.

      Parameters

      • timeout: number

        How long to wait for IE.

      Returns Options

      A self reference.

    • Deletes an entry from this set of capabilities.

      Parameters

      • key: string

        the capability key to delete.

      Returns boolean

    • Configures whether the driver should attempt to remove obsolete WebElements from its internal cache on page navigation (true by default). Disabling this option will cause the driver to run with a larger memory footprint.

      Parameters

      • enable: boolean

        Whether to enable element reference cleanup.

      Returns Options

      A self reference.

    • Configures whether to enable persistent mouse hovering (true by default). Persistent hovering is achieved by continuously firing mouse over events at the last location the mouse cursor has been moved to.

      Parameters

      • enable: boolean

        Whether to enable persistent hovering.

      Returns Options

      A self reference.

    • Configures whether to clear the cache, cookies, history, and saved form data before starting the browser. Using this capability will clear session data for all running instances of Internet Explorer, including those started manually.

      Parameters

      • cleanSession: boolean

        Whether to clear all session data on startup.

      Returns Options

      A self reference.

    • Configures whether to launch Internet Explorer using the CreateProcess API. If this option is not specified, IE is launched using IELaunchURL, if available. For IE 8 and above, this option requires the TabProcGrowth registry value to be set to 0.

      Parameters

      • force: boolean

        Whether to use the CreateProcess API.

      Returns Options

      A self reference.

    • Parameters

      • key: string

        The capability to return.

      Returns any

      The capability with the given key, or {@code null} if it has not been set.

    • Returns undefined | string

      the behavior pattern for responding to unhandled user prompts, or undefined if not set.

    • Returns undefined | string

      the configured browser name, or undefined if not set.

    • Returns undefined | string

      the configured browser version, or undefined if not set.

    • Returns the configured page load strategy.

      Returns undefined | string

      the page load strategy.

    • Returns undefined | string

      the configured platform or undefined if not set.

    • Parameters

      • key: string

        The capability to check.

      Returns boolean

      Whether the specified capability is set.

    • Indicates whether to skip the check that the browser's zoom level is set to 100%.

      Parameters

      • ignore: boolean

        Whether to ignore the browser's zoom level settings.

      Returns Options

      A self reference.

    • Sets the initial URL loaded when IE starts. This is intended to be used with #ignoreProtectedModeSettings to allow the user to initialize IE in the proper Protected Mode zone. Setting this option may cause browser instability or flaky and unresponsive code. Only 'best effort' support is provided when using this option.

      Parameters

      • url: string

        The initial browser URL.

      Returns Options

      A self reference.

    • Whether to disable the protected mode settings check when the session is created. Disbling this setting may lead to significant instability as the browser may become unresponsive/hang. Only 'best effort' support is provided when using this capability.

      For more information, refer to the IEDriver's required system configuration.

      Parameters

      • ignoreSettings: boolean

        Whether to ignore protected mode settings.

      Returns Options

      A self reference.

    • Configures whether to require the IE window to have input focus before performing any user interactions (i.e. mouse or keyboard events). This option is disabled by default, but delivers much more accurate interaction events when enabled.

      Parameters

      • require: boolean

        Whether to require window focus.

      Returns Options

      A self reference.

    • Parameters

      • key: string

        The capability key.

      • value: any

        The capability value.

      Returns Capabilities

      A self reference.

      Throws

      If the key is not a string.

    • Sets whether a WebDriver session should implicitly accept self-signed, or other untrusted TLS certificates on navigation.

      Parameters

      • accept: boolean

        whether to accept insecure certs.

      Returns Capabilities

      a self reference.

    • Sets the default action to take with an unexpected alert before returning an error. If unspecified, WebDriver will default to UserPromptHandler.DISMISS_AND_NOTIFY.

      Parameters

      • behavior: string

        The way WebDriver should respond to unhandled user prompts.

      Returns Capabilities

      A self reference.

    • Sets the IEDriver to drive Chromium-based Edge in Internet Explorer mode.

      Parameters

      • attachEdgeChromium: boolean

        Whether to run in Chromium-based-Edge in IE mode

      Returns Options

      A self reference.

    • Sets the path of the EdgeChromium driver.

      Parameters

      • path: string

        The EdgeChromium driver path

      Returns Options

      A self reference.

    • Sets the path of the temporary data directory to use.

      Parameters

      • path: string

        The log file path.

      Returns Options

      A self reference.

    • Sets the IP address of the driver's host adapter.

      Parameters

      • host: string

        The IP address to use.

      Returns Options

      A self reference.

    • Sets the path to the log file the driver should log to.

      Parameters

      • file: string

        The log file path.

      Returns Options

      A self reference.

    • Sets the IEDriverServer's logging level.

      Parameters

      • level: Level

        The logging level.

      Returns Options

      A self reference.

    • Sets whether the driver should start in silent mode.

      Parameters

      • silent: boolean

        Whether to run in silent mode.

      Returns Options

      A self reference.

    • Configures whether proxies should be configured on a per-process basis. If not set, setting a #setProxy proxy will configure the system proxy. The default behavior is to use the system proxy.

      Parameters

      • enable: boolean

        Whether to enable per-process proxy settings.

      Returns Options

      A self reference.

    Generated using TypeDoc