Function unwrapErr

unwrapErr<R extends UnknownTernaryResult>(result: R): UnwrapErr<R> | undefined

Safely unwraps the Err value.

Type Parameters

R extends UnknownTernaryResult

Parameters

result: R

Returns UnwrapErr<R> | undefined

Example

const errValue = TernaryResult.err('fail');

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

assert.strictEqual(TernaryResult.unwrapErr(errValue), 'fail');

// eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
assert.strictEqual(TernaryResult.unwrapErr(okValue), undefined);