KC's Workspace
    Preparing search index...

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    id: string

    Unique identifier. This ID is deterministic and will be the same for the same test across multiple runs. The ID is based on the project name, module url and test order.

    location: { column: number; line: number } | undefined

    Location in the module where the test or suite is defined.

    module: TestModule

    Direct reference to the test module where the test or suite is defined.

    name: string

    Name of the test.

    options: TaskOptions

    Options that the test was initiated with.

    Parent suite. If the test was called directly inside the module, the parent will be the module itself.

    project: TestProject

    The project associated with the test or suite.

    tags: string[]

    Tags associated with the test.

    type: "test"

    Accessors

    • get fullName(): string

      Full name of the test including all parent suites separated with >.

      Returns string

    Methods

    • Test annotations added via the task.annotate API during the test execution.

      Returns readonly TestAnnotation[]

    • Experimental

      Test artifacts recorded via the recordArtifact API during the test execution.

      Returns readonly TestArtifact[]

    • Useful information about the test like duration, memory usage, etc. Diagnostic is only available after the test has finished.

      Returns TestDiagnostic | undefined

    • Custom metadata that was attached to the test during its execution.

      Returns TaskMeta

    • Checks if the test did not fail the suite. If the test is not finished yet or was skipped, it will return true.

      Returns boolean

    • Test results.

      • pending: Test was collected, but didn't finish running yet.
      • passed: Test passed successfully
      • failed: Test failed to execute
      • skipped: Test was skipped during collection or dynamically with ctx.skip().

      Returns TestResult

    • Returns a new test specification that can be used to filter or run this specific test case.

      Returns TestSpecification