Skip to main content

BettererOptionsStart

API > @betterer/betterer > BettererOptionsStart

Options for when you run Betterer via the JS API.

Signature

export declare type BettererOptionsStart = BettererOptionsStartCI | BettererOptionsStartDefault | BettererOptionsStartPrecommit | BettererOptionsStartStrict | BettererOptionsStartUpdate;

Remarks

The options object will be validated by Betterer and turned into a BettererConfig.

This is the union of valid possible options for a single Betterer run. This type should prevent betterer() from being called with invalid options, as some combinations do not make sense.