Interface: SuiteRecord
A describe block, with what is written on the describe itself. Inherited values are on the tests.
Properties
id
id:
string
parentId
parentId:
string|null
The describe around this one; null at the top level.
bodyHash
bodyHash:
string|null
Hash of the describe's own code (hooks, test.use(), describe.configure(), helpers), ignoring whitespace, comments, and nested tests and describes; null when nothing is left.
relativeFilePath
relativeFilePath:
string
Path from the project root, with / separators.
fileName
fileName:
string
lineStart
lineStart:
number
lineEnd
lineEnd:
number
columnStart
columnStart:
number
In UTF-16 code units.
columnEnd
columnEnd:
number
In UTF-16 code units.
title
title:
string
As the runner shows it, tags included.
titleWithoutTags
titleWithoutTags:
string
title with @tag words removed and spaces tidied.
hasDynamicTitle
hasDynamicTitle:
boolean
The title could not be resolved to a fixed string, so title holds its source text.
path
path:
string[]
Titles of the describes around this one and of this one, outermost first.
isSkipped
isSkipped:
boolean
isFixme
isFixme:
boolean
Playwright only.
isTodo
isTodo:
boolean
Vitest only.
isExpectedToFail
isExpectedToFail:
boolean
Tests in the describe are expected to fail, as with test.fail() in its body. Playwright only.
isOnly
isOnly:
boolean
isConditional
isConditional:
boolean
The state applies only when a condition holds.
condition
condition:
string|null
Source text of the condition, shortened when long; null when unconditional.
reason
reason:
string|null
hasDynamicReason
hasDynamicReason:
boolean
The reason could not be worked out to a string, so reason holds its source text.
isParallel
isParallel:
boolean
isSerial
isSerial:
boolean
Playwright only.
isShuffled
isShuffled:
boolean
Vitest only.
isParameterized
isParameterized:
boolean
Declared with .each or .for.
tags
tags:
string[]
annotations
annotations:
object[]
type
type:
string
description
description:
string|null
lineStart
lineStart:
number
locks
locks:
string[]
Playwright only.
meta
meta:
Record<string,MetaValue> |null
Vitest only; literal values only.