Function unwrapWarn

unwrapWarn<R extends UnknownTernaryResult>(result: R): UnwrapWarn<R> | undefined

Safely unwraps the Warn value.

Type Parameters

R extends UnknownTernaryResult

Parameters

result: R

Returns UnwrapWarn<R> | undefined

Example

const warnValue = TernaryResult.warn('ok', 'careful');

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

assert.strictEqual(TernaryResult.unwrapWarn(warnValue), 'careful');

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