floss
Version:
Unit-testing for those hard to reach places
32 lines (31 loc) • 1.41 kB
TypeScript
interface FlossOptions {
path: string;
debug?: boolean;
electron?: string;
reporter?: string;
reporterOptions?: any;
require?: string;
args?: string[];
}
/**
* API to launch the Floss application.
* @module floss
* @param {Object|String} options The options map or path.
* @param {String} [options.path] Path to the JS file to run, can be a glob.
* @param {Boolean} [options.debug] `true` opens in headful mode.
* @param {String} [options.electron] Path to custom electron version. If undefined
* will use environment variable `ELECTRON_PATH` or electron
* installed alongside.
* @param {String} [options.require] Additional module to require.
* @param {String} [options.reporter=spec] Mocha reporter (non-debug mode only)
* @param {String|Object} [options.reporterOptions] Additional options for the reporter
* useful for specifying an output file if using the 'xunit' reporter.
* Options can be a querystring format, e.g., `"foo=2&bar=something"`
* @param {String[]} [options.args] Additional Electron arguments, can be useful
* for things like disable autoplay gestures, e.g.,
* `["--autoplay-policy=no-user-gesture-required"]`
* @param {Function} done Called when completed. Passes error if failed.
*/
declare function floss(options: string | FlossOptions): Promise<void>;
export { floss };
export type { FlossOptions };