Function isTernaryResult

isTernaryResult(maybeResult: unknown): maybeResult is UnknownTernaryResult

Checks whether the provided value is a TernaryResult.

Parameters

maybeResult: unknown

Returns maybeResult is UnknownTernaryResult

Example

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

const warnValue = TernaryResult.warn('done', 'retry later');

const notResult = { $$tag: 'ts-data-forge::Result.ok' };

assert.isTrue(TernaryResult.isTernaryResult(okValue));

assert.isTrue(TernaryResult.isTernaryResult(warnValue));

assert.isFalse(TernaryResult.isTernaryResult(notResult));