Class TestResultFailed

A failed test result. This should not be constructed manually. Instead, testFail should be used.

Index

Constructors

Properties

Methods

get getFailMessage getOrThrow getSideData isFailed isPassed map mapAsync

Constructors

constructor

new TestResultFailed(failMessage): TestResultFailed
Parameters
- failMessage: string
Returns TestResultFailed
- Defined in TestResult.ts:139

Properties

`Protected` `Readonly`failMessage

failMessage: string

Methods

get

get(): undefined
Get the value of the passed test, or undefined if the test failed.

Returns undefined
- Defined in TestResult.ts:162

getFailMessage

getFailMessage(): string
Get the failure message callback of the failed test, or undefined if the test passed.

Returns string
- Defined in TestResult.ts:183

getOrThrow

getOrThrow(): never
Get the value of the passed test, or throw an error if the test failed.

Returns never
- Defined in TestResult.ts:169

getSideData

getSideData(): never
The side data that will be passed to run.

Returns never
- Defined in TestResult.ts:176

isFailed

isFailed(): this is TestResultFailed
Check if the test has failed. If true, it will contain a failure message.

Returns this is TestResultFailed
- Defined in TestResult.ts:155

isPassed

isPassed(): this is TestResultPassed<any, any>
Check if the test has passed. If true, it will contain a value.

Returns this is TestResultPassed<any, any>
- Defined in TestResult.ts:147

map

map(): TestResultFailed
For passed tests, map the passed value to another value. Failed tests will remain unchanged.

This will not mutate the test result, and instead return a new test result.

Returns TestResultFailed
- Defined in TestResult.ts:193

mapAsync

mapAsync(): Promise<TestResultFailed>
For passed tests, asynchronously map the passed value to another value. Failed tests will remain unchanged.

This will not mutate the test result, and instead return a new test result.

Returns Promise<TestResultFailed>
- Defined in TestResult.ts:203