test.default.SuiteContext

interface SuiteContext

• readonly attempt: number

  The attempt number of the suite. This value is zero-based, so the first attempt is 0, the second attempt is 1, and so on. This property is useful in conjunction with the --test-rerun-failures option to determine the attempt number of the current run.

• readonly filePath: undefined | string

  The absolute path of the test file that created the current suite. If a test file imports additional modules that generate suites, the imported suites will return the path of the root test file.

• readonly fullName: string

  The name of the suite and each of its ancestors, separated by >.

• readonly name: string

  The name of the suite.

• readonly passed: boolean

  Indicates whether the suite and all of its subtests have passed.

• readonly signal: AbortSignal

  Can be used to abort test subtasks when the test has been aborted.

• diagnostic(

  message: string

  ): void;

  Output a diagnostic message. This is typically used for logging information about the current suite or its tests.

  test.describe('my suite', (suite) => {
    suite.diagnostic('Suite diagnostic message');
  });
  

  @param message

  A diagnostic message to output.