#Function: isResult()

isResult<T, E>(result): result is Result<T, E>

Defined in: functions/is-result.ts:25

Type guard to check if a value is a Result.

#Type Parameters

#T

T

The type of the success value.

#E

E

The type of the error value.

#Parameters

#result

unknown

The value to check.

#Returns

result is Result<T, E>

true if the value is a Result, otherwise false.

#Example

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

const value: unknown = { type: 'Success', value: 42 };
if (Result.isResult(value)) {
  // value is now typed as Result<unknown, unknown>
  console.log(value.type); // 'Success' or 'Failure'
}