geckodriver/dist/types.d.ts

Mozilla's Geckodriver for Node.js

import type { SpawnOptionsWithoutStdio, SpawnOptionsWithStdioTuple, StdioPipe, StdioNull } from 'node:child_process';
export type LogLevel = 'fatal' | 'error' | 'warn' | 'info' | 'config' | 'debug' | 'trace';
type StdioOption = StdioNull | StdioPipe;
export interface GeckodriverParameters {
    /**
     * List of hostnames to allow. By default the value of --host is allowed, and in addition if that's a well
     * known local address, other variations on well known local addresses are allowed. If --allow-hosts is
     * provided only exactly those hosts are allowed
     * @default []
     */
    allowHosts?: string[];
    /**
     * List of request origins to allow. These must be formatted as scheme://host:port. By default any request
     * with an origin header is rejected. If --allow-origins is provided then only exactly those origins
     * are allowed.
     * @default []
     */
    allowOrigins?: string[];
    /**
     * Path to the Firefox binary
     */
    binary?: string;
    /**
     * Connect to an existing Firefox instance
     * @default false
     */
    connectExisting?: boolean;
    /**
     * Host IP to use for WebDriver server
     * @default 127.0.0.1
     */
    host?: string;
    /**
     * Attach browser toolbox debugger for Firefox
     * @default false
     */
    jsdebugger?: boolean;
    /**
     * Set Gecko log level [possible values: fatal, error, warn, info, config, debug, trace]
     */
    log?: LogLevel;
    /**
     * write server log to file instead of stderr, increases log level to INFO
     */
    logNoTruncate?: boolean;
    /**
     * Host to use to connect to Gecko
     * @default 127.0.0.1
     */
    marionetteHost?: string;
    /**
     * Port to use to connect to Gecko
     * @default 0
     */
    marionettePort?: number;
    /**
     * port to listen on
     */
    port?: number;
    /**
     * port to use for Debugger / Webdriver BiDi
     */
    websocketPort?: number;
    /**
     * Directory in which to create profiles. Defaults to the system temporary directory.
     */
    profileRoot?: string;
    /**
     * Version of Geckodriver to start. See https://github.com/mozilla/geckodriver/releases for all available versions, platforms and architecture.
     */
    geckoDriverVersion?: string;
    /**
     * Don't download Geckodriver, instead use a custom path to it, e.g. a cached binary.
     */
    customGeckoDriverPath?: string;
    /**
     * The path to the root of the cache directory.
     * @default process.env.GECKODRIVER_CACHE_DIR || os.tmpdir()
     */
    cacheDir?: string;
    /**
     * options to be passed into the process.
     * @see options in https://nodejs.org/api/child_process.html#child_processspawncommand-args-options
     * @default undefined
     */
    spawnOpts?: SpawnOptionsWithoutStdio | SpawnOptionsWithStdioTuple<StdioOption, StdioOption, StdioOption>;
}
declare global {
    namespace WebdriverIO {
        interface GeckodriverOptions extends GeckodriverParameters {
        }
    }
}
export {};
//# sourceMappingURL=types.d.ts.map