Function: isResult()

isResult(value): value is Result<any, any>

Defined in: index.ts:265

Type guard that checks if a value is a valid Result (either Ok or Err). Validates the structure to ensure it has the correct shape.

Parameters

value

unknown

The value to check

Returns

value is Result<any, any>

true if the value is a valid Result, false otherwise

Example

if (isResult(value)) {
  // value is now typed as Result
  if (value.success) {
    console.log(value.data);
  } else {
    console.log(someValue.error);
  }
}