Interface WebExtRunOptions

interface WebExtRunOptions {
    artifactsDir: string;
    browserConsole: boolean;
    firefox: string;
    keepProfileChanges: boolean;
    noReload: boolean;
    preInstall: boolean;
    sourceDir: string;
    pref?: {
        [key: string]: boolean | number | string;
    };
    firefoxProfile?: string;
    ignoreFiles?: string[];
    noInput?: boolean;
    watchFile?: string;
    startUrl?: string[];
    target?: string[];
    args?: string[];
    adbBin?: string;
    adbHost?: string;
    adbPort?: string;
    adbDevice?: string;
    adbDiscoveryTimeout?: number;
    firefoxApk?: string;
    firefoxApkComponent?: string;
    chromiumBinary?: string;
    chromiumProfile?: string;
}

Properties

artifactsDir browserConsole firefox keepProfileChanges noReload preInstall sourceDir pref? firefoxProfile? ignoreFiles? noInput? watchFile? startUrl? target? args? adbBin? adbHost? adbPort? adbDevice? adbDiscoveryTimeout? firefoxApk? firefoxApkComponent? chromiumBinary? chromiumProfile?

Properties

artifactsDir

artifactsDir: string

The directory where packages are copied to.

browserConsole

browserConsole: boolean

Show the browser console on startup

firefox

firefox: string

Location of firefox executable.

keepProfileChanges

keepProfileChanges: boolean

Persist user profile changes to disk.

noReload

noReload: boolean

Turn off reloading when watching files.

preInstall

preInstall: boolean

Used for older versions of firefox to preinstall your extension before running.

sourceDir

sourceDir: string

Directory where your application files will be built to.

Optional pref

pref?: {
    [key: string]: boolean | number | string;
}

Firefox preferences overrides.

Type declaration

  • [key: string]: boolean | number | string

Optional firefoxProfile

firefoxProfile?: string

Location of firefox user profile folder.

Optional ignoreFiles

ignoreFiles?: string[]

Array of files to ignore when building/watching/linting.

Optional noInput

noInput?: boolean

Mark this session as non-interactive.

Optional watchFile

watchFile?: string

Watch additional files outside of the source directory.

Optional startUrl

startUrl?: string[]

URL to navigate to on startup.

Optional target

target?: string[]

Browser(s) to use for testing.

Optional args

args?: string[]

Arguments to pass to target browsers.

Optional adbBin

adbBin?: string

Executable for android's debugging instance.

Optional adbHost

adbHost?: string

Remote hostname for an ADB socket.

Optional adbPort

adbPort?: string

Remote port for an ADB socket.

Optional adbDevice

adbDevice?: string

Remote target for ADB.

Optional adbDiscoveryTimeout

adbDiscoveryTimeout?: number

Time to wait for ADB's initial handshake to be successful.

Optional firefoxApk

firefoxApk?: string

Application package to use for testing Firefox on Android.

Optional firefoxApkComponent

firefoxApkComponent?: string

Custom view name to control on Android.

Optional chromiumBinary

chromiumBinary?: string

Path to custom chromium binary.

Optional chromiumProfile

chromiumProfile?: string

Path to custom chromium user profile.

Settings

Member Visibility

Theme

On This Page

artifactsDirbrowserConsolefirefoxkeepProfileChangesnoReloadpreInstallsourceDirpreffirefoxProfileignoreFilesnoInputwatchFilestartUrltargetargsadbBinadbHostadbPortadbDeviceadbDiscoveryTimeoutfirefoxApkfirefoxApkComponentchromiumBinarychromiumProfile