Function: isSuccess()

isSuccess<T>(result): result is Success<T>

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

Type guard to check if a Result is a Success.

Type Parameters

T

T

The type of the success value.

Parameters

result

Result<T, unknown>

The Result to check.

Returns

result is Success<T>

true if the result is a Success, otherwise false.

Example

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

const result: Result.Result<number, string> = { type: 'Success', value: 10 };
if (Result.isSuccess(result)) {
  console.log(result.value); // Safe access to value
}