betterer()

API > @betterer/betterer > betterer

Run Betterer with the given options.

Signature

export declare function betterer(options?: BettererOptionsStart): Promise<BettererSuiteSummary>;

Parameters

Parameter	Type	Description
options	BettererOptionsStart	Options for running Betterer.

Returns

Promise<BettererSuiteSummary>

Exceptions

BettererError Will throw if something goes wrong while running Betterer.

Example

import { betterer } from '@betterer/betterer';

const suiteSummary = await betterer(options);