Skip to main content

interface TestOptions

Properties #

#concurrency:
number
| boolean
| undefined
optional

If a number is provided, then that many tests would run in parallel. If truthy, it would run (number of cpu cores - 1) tests in parallel. For subtests, it will be Infinity tests in parallel. If falsy, it would only run one test at a time. If unspecified, subtests inherit this value from their parent.

#only: boolean | undefined
optional

If truthy, and the test context is configured to run only tests, then this test will be run. Otherwise, the test is skipped.

#signal: AbortSignal | undefined
optional

Allows aborting an in-progress test.

#skip:
boolean
| string
| undefined
optional

If truthy, the test is skipped. If a string is provided, that string is displayed in the test results as the reason for skipping the test.

#timeout: number | undefined
optional

A number of milliseconds the test will fail after. If unspecified, subtests inherit this value from their parent.

#todo:
boolean
| string
| undefined
optional

If truthy, the test marked as TODO. If a string is provided, that string is displayed in the test results as the reason why the test is TODO.

#plan: number | undefined
optional

The number of assertions and subtests expected to be run in the test. If the number of assertions run in the test does not match the number specified in the plan, the test will fail.

Did you find what you needed?

Privacy policy