Variable isResult`Const`

isResult: (maybeResult: unknown) => maybeResult is UnknownResult

Checks whether the provided value is a Result<S, E>.

Type Declaration

- (maybeResult: unknown): maybeResult is UnknownResult
- Parameters
  - maybeResult: unknown
  Returns maybeResult is UnknownResult

Example

const okValue = Result.ok('success');

const errValue = Result.err(new Error('failure'));

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

assert.isTrue(Result.isResult(okValue));

assert.isTrue(Result.isResult(errValue));

assert.isFalse(Result.isResult(notResult));