| 1 | interface FlossOptions {
|
| 2 | path: string;
|
| 3 | debug?: boolean;
|
| 4 | electron?: string;
|
| 5 | reporter?: string;
|
| 6 | reporterOptions?: any;
|
| 7 | require?: string;
|
| 8 | args?: string[];
|
| 9 | }
|
| 10 | /**
|
| 11 | * API to launch the Floss application.
|
| 12 | * @module floss
|
| 13 | * @param {Object|String} options The options map or path.
|
| 14 | * @param {String} [options.path] Path to the JS file to run, can be a glob.
|
| 15 | * @param {Boolean} [options.debug] `true` opens in headful mode.
|
| 16 | * @param {String} [options.electron] Path to custom electron version. If undefined
|
| 17 | * will use environment variable `ELECTRON_PATH` or electron
|
| 18 | * installed alongside.
|
| 19 | * @param {String} [options.require] Additional module to require.
|
| 20 | * @param {String} [options.reporter=spec] Mocha reporter (non-debug mode only)
|
| 21 | * @param {String|Object} [options.reporterOptions] Additional options for the reporter
|
| 22 | * useful for specifying an output file if using the 'xunit' reporter.
|
| 23 | * Options can be a querystring format, e.g., `"foo=2&bar=something"`
|
| 24 | * @param {String[]} [options.args] Additional Electron arguments, can be useful
|
| 25 | * for things like disable autoplay gestures, e.g.,
|
| 26 | * `["--autoplay-policy=no-user-gesture-required"]`
|
| 27 | * @param {Function} done Called when completed. Passes error if failed.
|
| 28 | */
|
| 29 | declare function floss(options: string | FlossOptions): Promise<void>;
|
| 30 | export { floss };
|
| 31 | export type { FlossOptions };
|