Skip to main content Link Search Menu Expand Document (external link)

TestConfig overview

Added in v2.0.0


Table of contents


utils

TestConfig

Signature

export declare const TestConfig: Context.Tag<TestConfig, TestConfig>

Added in v2.0.0

TestConfig (interface)

The TestConfig service provides access to default configuration settings used by tests, including the number of times to repeat tests to ensure they are stable, the number of times to retry flaky tests, the sufficient number of samples to check from a random variable, and the maximum number of shrinkings to minimize large failures.

Signature

export interface TestConfig {
  /**
   * The number of times to repeat tests to ensure they are stable.
   */
  readonly repeats: number
  /**
   * The number of times to retry flaky tests.
   */
  readonly retries: number
  /**
   * The number of sufficient samples to check for a random variable.
   */
  readonly samples: number
  /**
   * The maximum number of shrinkings to minimize large failures
   */
  readonly shrinks: number
}

Added in v2.0.0

make

Signature

export declare const make: (params: {
  readonly repeats: number
  readonly retries: number
  readonly samples: number
  readonly shrinks: number
}) => TestConfig

Added in v2.0.0