Function expectToBe

expectToBe<R extends UnknownResult>(result: R, message: string): UnwrapOk<R>
Unwraps a Result, returning the success value or throwing an error with the provided message.
Type Parameters
- R extends UnknownResult
  The UnknownResult type to unwrap.
Parameters
- result: R
  The Result to unwrap.
- message: string
  The error message to throw if the Result is Result.Err.
Returns UnwrapOk<R>
The success value if Result.Ok.
Example
```
const okValue = Result.ok('data');

assert.isTrue(Result.expectToBe(okValue, 'should have value') === 'data');

const expectResult = Result.expectToBe<string>('missing result');

assert.throws(() => expectResult(Result.err('boom')), /missing result/u);

assert.isTrue(expectResult(Result.ok('value')) === 'value');
```
Throws
Error with the provided message if the Result is Result.Err.
- Defined in src/functional/result/impl/result-expect-to-be.mts:29
expectToBe<S>(message: string): <E>(result: Result<S, E>) => S
Unwraps a Result, returning the success value or throwing an error with the provided message.
Type Parameters
- S
Parameters
- message: string
  The error message to throw if the Result is Result.Err.
Returns <E>(result: Result<S, E>) => S
The success value if Result.Ok.
Example
```
const okValue = Result.ok('data');

assert.isTrue(Result.expectToBe(okValue, 'should have value') === 'data');

const expectResult = Result.expectToBe<string>('missing result');

assert.throws(() => expectResult(Result.err('boom')), /missing result/u);

assert.isTrue(expectResult(Result.ok('value')) === 'value');
```
Throws
Error with the provided message if the Result is Result.Err.
- Defined in src/functional/result/impl/result-expect-to-be.mts:35

Function expectToBe

Type Parameters

Parameters

Returns UnwrapOk<R>

Example

Throws

Type Parameters

Parameters

Returns <E>(result: Result<S, E>) => S

Example

Throws

Settings