Function expectToBe

expectToBe<R extends UnknownTernaryResult>(
result: R,
message: string,
): UnwrapOk<R>

Unwraps the Ok value or throws with the provided message.

Type Parameters

R extends UnknownTernaryResult

Parameters

result: R
message: string

Returns UnwrapOk<R>

Example

const okValue = TernaryResult.ok('ready');

assert.strictEqual(TernaryResult.expectToBe(okValue, 'missing'), 'ready');

const expectResult = TernaryResult.expectToBe('needs value');

const throwTest = (): void => {
  expectResult(TernaryResult.err('oops'));
};

assert.throws(throwTest, /needs value/u);

expectToBe(message: string): <S, W, E>(result: TernaryResult<S, E, W>) => S

Unwraps the Ok value or throws with the provided message.

Parameters

message: string

Returns <S, W, E>(result: TernaryResult<S, E, W>) => S

Example

const okValue = TernaryResult.ok('ready');

assert.strictEqual(TernaryResult.expectToBe(okValue, 'missing'), 'ready');

const expectResult = TernaryResult.expectToBe('needs value');

const throwTest = (): void => {
  expectResult(TernaryResult.err('oops'));
};

assert.throws(throwTest, /needs value/u);

Function expectToBe

Type Parameters

Parameters

Returns UnwrapOk<R>

Example

Parameters

Returns <S, W, E>(result: TernaryResult<S, E, W>) => S

Example

Settings