effect-io-ai

Package: effect
Module: Effect

Effect.isSuccess

Returns whether an effect completes successfully.

Details

Returns false for failures in the error channel, but defects still fail the effect.

Example (Checking whether an effect succeeds)

import { Console, Effect } from "effect"

const program = Effect.gen(function*() {
  const ok = yield* Effect.isSuccess(Effect.succeed("done"))
  const failed = yield* Effect.isSuccess(Effect.fail("Uh oh"))
  yield* Console.log(`ok: ${ok}`)
  yield* Console.log(`failed: ${failed}`)
})

Effect.runPromise(program)
// Output:
// ok: true
// failed: false

Signature

declare const isSuccess: <A, E, R>(self: Effect<A, E, R>) => Effect<boolean, never, R>

Source

Since v2.0.0