Class TestResultPassed<T, TS>

A passed test result. This should not be constructed manually. Instead, testPass should be used.

Type Parameters

T
TS

Index

Constructors

Properties

Methods

get getFailMessage getOrThrow getSideData isFailed isPassed map mapAsync

Constructors

constructor

new TestResultPassed<T, TS>(passValue: T, sideData: TS): TestResultPassed<T, TS>
Type Parameters
- T
- TS
Parameters
- passValue: T
- sideData: TS
Returns TestResultPassed<T, TS>
- Defined in TestResult.ts:57

Properties

`Protected` `Readonly`sideData

sideData: TS

`Protected` `Readonly`value

value: T

Methods

get

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

Returns T
- Defined in TestResult.ts:81

getFailMessage

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

Returns undefined
- Defined in TestResult.ts:102

getOrThrow

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

Returns T
- Defined in TestResult.ts:88

getSideData

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

Returns TS
- Defined in TestResult.ts:95

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:74

isPassed

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

Returns this is TestResultPassed<T, TS>
- Defined in TestResult.ts:66

map

map<T2>(mapper: (value: T, sideData: TS) => T2): TestResultPassed<T2, TS>
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.
Type Parameters
- T2
Parameters
- mapper: (value: T, sideData: TS) => T2
  A function that will transform the passed value.
Returns TestResultPassed<T2, TS>
- Defined in TestResult.ts:114

mapAsync

mapAsync<T2>(
mapper: (value: T, sideData: TS) => Promise<T2>,
): Promise<TestResultPassed<T2, TS>>
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.
Type Parameters
- T2
Parameters
- mapper: (value: T, sideData: TS) => Promise<T2>
  A function that will transform the passed value.
Returns Promise<TestResultPassed<T2, TS>>
- Defined in TestResult.ts:126