effect-io-ai

Package: effect
Module: Result

Result.isSuccess

Checks whether a Result is a Success.

When to use

Use to narrow a known Result to the Success variant.

Details

• Acts as a TypeScript type guard, narrowing to Success<A, E>
• After narrowing, you can access .success to read the value

Example (Narrowing to success)

import { Result } from "effect"

const result = Result.succeed(42)

if (Result.isSuccess(result)) {
  console.log(result.success)
  // Output: 42
}

See

• isFailure for the opposite check
• isResult to check if a value is any Result

Signature

declare const isSuccess: <A, E>(self: Result<A, E>) => self is Success<A, E>

Source

Since v4.0.0