playwright/docs/src/test-reporter-api/class-teststep.md

# class: TestStep
* since: v1.10
* langs: js

Represents a step in the [TestRun].

## property: TestStep.category
* since: v1.10
- type: <[string]>

Step category to differentiate steps with different origin and verbosity. Built-in categories are:
* `hook` for fixtures and hooks initialization and teardown
* `expect` for expect calls
* `pw:api` for Playwright API calls.
* `test.step` for test.step API calls.

## property: TestStep.duration
* since: v1.10
- type: <[float]>

Running time in milliseconds.

## property: TestStep.location
* since: v1.10
- type: ?<[Location]>

Optional location in the source where the step is defined.

## property: TestStep.error
* since: v1.10
- type: ?<[TestError]>

Error thrown during the step execution, if any.

## property: TestStep.parent
* since: v1.10
- type: ?<[TestStep]>

Parent step, if any.

## property: TestStep.startTime
* since: v1.10
- type: <[Date]>

Start time of this particular test step.

## property: TestStep.steps
* since: v1.10
- type: <[Array]<[TestStep]>>

List of steps inside this step.

## property: TestStep.title
* since: v1.10
- type: <[string]>

User-friendly test step title.

## method: TestStep.titlePath
* since: v1.10
- returns: <[Array]<[string]>>

Returns a list of step titles from the root step down to this step.
feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00			`# class: TestStep`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00			`* langs: js`

			`Represents a step in the [TestRun].`

			`## property: TestStep.category`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00			`- type: <[string]>`

			`Step category to differentiate steps with different origin and verbosity. Built-in categories are:`
			* `hook` for fixtures and hooks initialization and teardown
			* `expect` for expect calls
			* `pw:api` for Playwright API calls.
feat(test-runner): render step titles (#8270) 2021-08-17 16:41:36 -07:00			* `test.step` for test.step API calls.
feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00
			`## property: TestStep.duration`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00			`- type: <[float]>`

			`Running time in milliseconds.`

feat(api): expose step location (#9602) 2021-10-18 20:06:18 -08:00			`## property: TestStep.location`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?". 2022-04-06 19:02:10 -07:00			`- type: ?<[Location]>`
feat(api): expose step location (#9602) 2021-10-18 20:06:18 -08:00
chore: generate more types (#13358) As a result, fix documentation issues: - Removed `TestStep.data` that is not a thing. - Added `TestConfig.name` documentation. - Refined a lot of optional types in the documentation. - Aligned `test.fail()` and `test.slow()` docs with `test.skip()`. - Strict set of docs vs types inconsistensies in the generator 2022-04-06 13:36:20 -07:00			`Optional location in the source where the step is defined.`
feat(api): expose step location (#9602) 2021-10-18 20:06:18 -08:00
feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00			`## property: TestStep.error`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?". 2022-04-06 19:02:10 -07:00			`- type: ?<[TestError]>`
feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?". 2022-04-06 19:02:10 -07:00			`Error thrown during the step execution, if any.`
feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00
feat(test-runner): render step titles (#8270) 2021-08-17 16:41:36 -07:00			`## property: TestStep.parent`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?". 2022-04-06 19:02:10 -07:00			`- type: ?<[TestStep]>`
feat(test-runner): render step titles (#8270) 2021-08-17 16:41:36 -07:00
docs: mark optional properties/arguments explicitly with "?" (#13369) Previously, we were guessing whether something is optional from the comment (looking for stuff like "defaults to" or "optional"). To remove this error-prone technique, every optional property or argument (but not option) is explicitly marked with "?". 2022-04-06 19:02:10 -07:00			`Parent step, if any.`
feat(test-runner): render step titles (#8270) 2021-08-17 16:41:36 -07:00
feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00			`## property: TestStep.startTime`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00			`- type: <[Date]>`

			`Start time of this particular test step.`

feat(test-runner): report nested steps (#8266) 2021-08-17 13:57:26 -07:00			`## property: TestStep.steps`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
feat(test-runner): report nested steps (#8266) 2021-08-17 13:57:26 -07:00			`- type: <[Array]<[TestStep]>>`

			`List of steps inside this step.`

feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00			`## property: TestStep.title`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00			`- type: <[string]>`

			`User-friendly test step title.`
feat(test-runner): render step titles (#8270) 2021-08-17 16:41:36 -07:00
			`## method: TestStep.titlePath`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
feat(test-runner): render step titles (#8270) 2021-08-17 16:41:36 -07:00			`- returns: <[Array]<[string]>>`

			`Returns a list of step titles from the root step down to this step.`