#Function: isFailure()

isFailure<E>(result): result is Failure<E>

Defined in: functions/is-failure.ts:23

Type guard to check if a Result is a Failure.

#Type Parameters

#E

E

The type of the error value.

#Parameters

#result

Result<unknown, E>

The Result to check.

#Returns

result is Failure<E>

true if the result is a Failure, otherwise false.

#Example

import { Result } from '@praha/byethrow';

const result: Result.Result<number, string> = { type: 'Failure', error: 'Something went wrong' };
if (Result.isFailure(result)) {
  console.error(result.error); // Safe access to error
}