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

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

Information about an error thrown during test execution.

## property: TestError.cause
* since: v1.49
- type: ?<[TestError]>

Error cause. Set when there is a [cause](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause) for the error. Will be `undefined` if there is no cause or if the cause is not an instance of [Error].

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

Error message. Set when [Error] (or its subclass) has been thrown.

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

Error stack. Set when [Error] (or its subclass) has been thrown.

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

The value that was thrown. Set when anything except the [Error] (or its subclass) has been thrown.

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

Error location in the source code.

## property: TestError.snippet
* since: v1.33
- type: ?<[string]>

Source code snippet with highlighted error.
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`# class: TestError`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02:00			`* since: v1.10`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`* langs: js`

			`Information about an error thrown during test execution.`

feat(pwt): serialize and expose Error.cause from Worker process (#32833) 2024-10-29 00:01:59 +01:00			`## property: TestError.cause`
			`* since: v1.49`
			`- type: ?<[TestError]>`

			Error cause. Set when there is a [cause](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/cause) for the error. Will be `undefined` if there is no cause or if the cause is not an instance of [Error].

docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00			`## property: TestError.message`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02: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-07 04:02:10 +02:00			`- type: ?<[string]>`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02: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-07 04:02:10 +02:00			`Error message. Set when [Error] (or its subclass) has been thrown.`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00
			`## property: TestError.stack`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02: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-07 04:02:10 +02:00			`- type: ?<[string]>`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02: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-07 04:02:10 +02:00			`Error stack. Set when [Error] (or its subclass) has been thrown.`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02:00
			`## property: TestError.value`
docs: annotate since (#15386) 2022-07-06 02:24:50 +02: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-07 04:02:10 +02:00			`- type: ?<[string]>`
docs(test runner): api reference for reporter api (#7811) 2021-07-23 04:56:36 +02: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-07 04:02:10 +02:00			`The value that was thrown. Set when anything except the [Error] (or its subclass) has been thrown.`
chore: report error location for fatal errors (#19610) 2022-12-21 18:36:59 +01:00
			`## property: TestError.location`
			`* since: v1.30`
			`- type: ?<[Location]>`

			`Error location in the source code.`
chore: add snippet to the error message (#21991) 2023-03-29 23:07:14 +02:00
			`## property: TestError.snippet`
			`* since: v1.33`
			`- type: ?<[string]>`

			`Source code snippet with highlighted error.`