Options

The Options interface is used to configure test behavior and parameters. It includes various settings that control test execution, retries, and conditions.

Usage Example

Options can only be passed as a third arguments to every TestCase method.

test.test.ts

import "veve"
 
it("should pass", () => {}, {
  // Options can be passed here
  bench: true,
  timeout: 5000 
})

Options Reference Table

Prop	Type	Default
`timeout`	`number`	`300.000`
`skip`	`boolean`	`false`
`if`	`boolean \| undefined \| null \| (() => boolean \| Promise<boolean> \| null \| undefined)`	`true`
`retry`	`number`	`0`
`softfail`	`boolean`	`false`
`sequencial`	`boolean`	`false`
`bench`	`boolean`	`false`
`todo`	`boolean`	`false`
`iterations`	`number \| undefined`	`1000`
`warmup`	`number \| undefined`	`50`
`confidence`	`number \| undefined`	`0.95`

Timeout Settings

`timeout`

Description: The maximum time (in milliseconds) a test is allowed to run before timing out.
Type: number
Default: 300000

`retry`

Description: The number of times the test should be retried upon failure.
Type: number
Default: 0

Test Execution Conditions

`skip`

Description: Indicates whether the test should be skipped.
Type: boolean
Default: false

`todo`

Description: Indicates whether the test is marked as a "to-do" item.
Type: boolean
Default: false

Execution Flow Options

`sequencial`

Description: Indicates whether the test should be run sequentially.
Type: boolean
Default: false

`softfail`

Description: Indicates whether the test should allow soft failures without halting the test suite.
Type: boolean
Default: false

Benchmarking Options

`bench`

Description: Indicates whether the test is a benchmark test.
Type: boolean
Default: false

`iterations`

Description: The number of iterations the test should run while benching.
Type: number | undefined
Default: 1000

`warmup`

Description: The number of warmup iterations before the actual test begins in benching.
Type: number | undefined
Default: 50

`confidence`

Description: The confidence level for statistical calculations (between 0 and 1). Used to calculate confidence intervals for the benchmark results.
Type: number | undefined
Default: 0.95