BettererReporter.suiteStart()
API > @betterer/betterer > BettererReporter > suiteStart
The suiteStart() hook is called when a BettererSuite run starts. The lifecycle promise will resolve when the suite run ends or reject when the suite run throws an error, so it can be used instead of the BettererReporter.suiteEnd() and BettererReporter.suiteError() hooks.
Signature
suiteStart?(suite: BettererSuite, lifecycle: Promise<BettererSuiteSummary>): Promise<void> | void;
Parameters
| Parameter | Type | Description |
|---|---|---|
| suite | BettererSuite | The BettererSuite. |
| lifecycle | Promise<BettererSuiteSummary> | A promise that resolves when the suite run ends and rejects when the suite run throws. |
Returns
Promise<void> | void