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

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

A result of a single [TestCase] run.

## property: TestResult.attachments
* since: v1.10
- type: <[Array]<[Object]>>
  - `name` <[string]> Attachment name.
  - `contentType` <[string]> Content type of this attachment to properly present in the report, for example `'application/json'` or `'image/png'`.
  - `path` ?<[string]> Optional path on the filesystem to the attached file.
  - `body` ?<[Buffer]> Optional attachment body used instead of a file.

The list of files or buffers attached during the test execution through [`property: TestInfo.attachments`].

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

Running time in milliseconds.

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

First error thrown during test execution, if any. This is equal to the first
element in [`property: TestResult.errors`].

## property: TestResult.errors
* since: v1.10
- type: <[Array]<[TestError]>>

Errors thrown during the test execution.

## property: TestResult.retry
* since: v1.10
- type: <[int]>

When test is retries multiple times, each retry attempt is given a sequential number.

Learn more about [test retries](../test-retries.md#retries).

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

Start time of this particular test run.

## property: TestResult.status
* since: v1.10
- type: <[TestStatus]<"passed"|"failed"|"timedOut"|"skipped"|"interrupted">>

The status of this test result. See also [`property: TestCase.expectedStatus`].

## property: TestResult.stderr
* since: v1.10
- type: <[Array]<[string]|[Buffer]>>

Anything written to the standard error during the test run.

## property: TestResult.stdout
* since: v1.10
- type: <[Array]<[string]|[Buffer]>>

Anything written to the standard output during the test run.

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

List of steps inside this test run.

## property: TestResult.workerIndex
* since: v1.10
- type: <[int]>

Index of the worker where the test was run. If the test was not run a single time, for example when the user interrupted testing, the only result will have a `workerIndex` equal to `-1`.

Learn more about [parallelism and sharding](../test-parallel.md) with Playwright Test.
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00			`# class: TestResult`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00			`* langs: js`

			`A result of a single [TestCase] run.`

			`## property: TestResult.attachments`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00			`- type: <[Array]<[Object]>>`
			- `name` <[string]> Attachment name.
			- `contentType` <[string]> Content type of this attachment to properly present in the report, for example `'application/json'` or `'image/png'`.
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			- `path` ?<[string]> Optional path on the filesystem to the attached file.
			- `body` ?<[Buffer]> Optional attachment body used instead of a file.
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00
			The list of files or buffers attached during the test execution through [`property: TestInfo.attachments`].

			`## property: TestResult.duration`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00			`- type: <[float]>`

			`Running time in milliseconds.`

			`## property: TestResult.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]>`
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56: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			`First error thrown during test execution, if any. This is equal to the first`
feat(test-runner): support expect.soft (#11800) Soft expects will still fail the test, but will not abort it's execution. As a consequence of this: - `TestResult` now might have multiple errors, which is reflected with a new `testResult.erros: TestError[]` field. - `TestInfo` now might have multiple errors as well, which is reflected with a new `testInfo.errors: TestError[]` field. Fixes #7819 2022-02-02 19:33:51 -07:00			element in [`property: TestResult.errors`].

			`## property: TestResult.errors`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
feat(test-runner): support expect.soft (#11800) Soft expects will still fail the test, but will not abort it's execution. As a consequence of this: - `TestResult` now might have multiple errors, which is reflected with a new `testResult.erros: TestError[]` field. - `TestInfo` now might have multiple errors as well, which is reflected with a new `testInfo.errors: TestError[]` field. Fixes #7819 2022-02-02 19:33:51 -07:00			`- type: <[Array]<[TestError]>>`

			`Errors thrown during the test execution.`
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00
			`## property: TestResult.retry`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00			`- type: <[int]>`

			`When test is retries multiple times, each retry attempt is given a sequential number.`

chore: add link validation for docs (#13047) 2022-03-25 19:30:45 +01:00			`Learn more about [test retries](../test-retries.md#retries).`
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00
			`## property: TestResult.startTime`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00			`- type: <[Date]>`

			`Start time of this particular test run.`

			`## property: TestResult.status`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
feat(test runner): separate interrupted status from skipped (#16124) 2022-08-02 12:55:43 -07:00			`- type: <[TestStatus]<"passed"\|"failed"\|"timedOut"\|"skipped"\|"interrupted">>`
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00
			The status of this test result. See also [`property: TestCase.expectedStatus`].

			`## property: TestResult.stderr`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00			`- type: <[Array]<[string]\|[Buffer]>>`

			`Anything written to the standard error during the test run.`

			`## property: TestResult.stdout`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00			`- type: <[Array]<[string]\|[Buffer]>>`

			`Anything written to the standard output during the test run.`

feat(test-runner): introduce steps (#7952) 2021-08-02 17:17:20 -07:00			`## property: TestResult.steps`
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: <[Array]<[TestStep]>>`

			`List of steps inside this test run.`

docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00			`## property: TestResult.workerIndex`
docs: annotate since (#15386) 2022-07-05 16:24:50 -08:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00			`- type: <[int]>`

fix(test runner): default workerIndex to -1 (#13440) 2022-04-08 15:23:23 -07:00			Index of the worker where the test was run. If the test was not run a single time, for example when the user interrupted testing, the only result will have a `workerIndex` equal to `-1`.
docs(test runner): api reference for reporter api (#7811) 2021-07-22 19:56:36 -07:00
chore: add link validation for docs (#13047) 2022-03-25 19:30:45 +01:00			`Learn more about [parallelism and sharding](../test-parallel.md) with Playwright Test.`