results()

API > @betterer/betterer > results

Get a summary of the results of the defined BettererTests.

Betterer will read the test definition file and the results file and return a summary of the results.

Signature

export declare function results(options?: BettererOptionsResults): Promise<BettererResultsSummary>;

Parameters

Parameter	Type	Description
options	BettererOptionsResults	Options for getting the summary of the results.

Returns

Promise<BettererResultsSummary>

Exceptions

BettererError Will throw if something goes wrong while getting the summary of the results.

Example

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

const resultsSummary = await betterer.results(options);