floss

  • Version 5.0.1
  • Published
  • 38.8 kB
  • 5 dependencies
  • MIT license

Install

npm i floss
yarn add floss
pnpm add floss

Overview

Unit-testing for those hard to reach places

Index

Functions

function floss

floss: (options: string | FlossOptions) => Promise<void>;
  • API to launch the Floss application. floss

    Parameter options

    The options map or path.

    Parameter

    {String} [options.path] Path to the JS file to run, can be a glob.

    Parameter

    {Boolean} [options.debug] true opens in headful mode.

    Parameter

    {String} [options.electron] Path to custom electron version. If undefined will use environment variable ELECTRON_PATH or electron installed alongside.

    Parameter

    {String} [options.require] Additional module to require.

    Parameter

    {String} [options.reporter=spec] Mocha reporter (non-debug mode only)

    Parameter

    {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"

    Parameter

    {String[]} [options.args] Additional Electron arguments, can be useful for things like disable autoplay gestures, e.g., ["--autoplay-policy=no-user-gesture-required"]

    Parameter done

    Called when completed. Passes error if failed.

Interfaces

interface FlossOptions

interface FlossOptions {}

    property args

    args?: string[];

      property debug

      debug?: boolean;

        property electron

        electron?: string;

          property path

          path: string;

            property reporter

            reporter?: string;

              property reporterOptions

              reporterOptions?: any;

                property require

                require?: string;

                  Package Files (1)

                  Dependencies (5)

                  Dev Dependencies (13)

                  Peer Dependencies (2)

                  Badge

                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/floss.

                  • Markdown
                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/floss)
                  • HTML
                    <a href="https://www.jsdocs.io/package/floss"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>