<A, E, R>(self: Effect<A, E, R>): Effect<boolean, never, R>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: falseexport const const isSuccess: <A, E, R>(
self: Effect<A, E, R>
) => Effect<boolean, never, R>
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
isSuccess: <function (type parameter) A in <A, E, R>(self: Effect<A, E, R>): Effect<boolean, never, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<boolean, never, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<boolean, never, R>R>(self: Effect<A, E, R>(parameter) self: {
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
}
interface Effect<out A, out E = never, out R = never>The Effect interface defines a value that lazily describes a workflow or
job. The workflow requires some context R, and may fail with an error of
type E, or succeed with a value of type A.
When to use
Use when you need to represent a lazy, composable workflow that can require
services, fail with a typed error, or succeed with a typed value.
Details
Effect values model resourceful interaction with the outside world,
including synchronous, asynchronous, concurrent, and parallel interaction.
They use a fiber-based concurrency model, with built-in support for
scheduling, fine-grained interruption, structured concurrency, and high
scalability.
To run an Effect value, you need a Runtime, which is a type that is
capable of executing Effect values.
Effect<function (type parameter) A in <A, E, R>(self: Effect<A, E, R>): Effect<boolean, never, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<boolean, never, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<boolean, never, R>R>) => interface Effect<out A, out E = never, out R = never>The Effect interface defines a value that lazily describes a workflow or
job. The workflow requires some context R, and may fail with an error of
type E, or succeed with a value of type A.
When to use
Use when you need to represent a lazy, composable workflow that can require
services, fail with a typed error, or succeed with a typed value.
Details
Effect values model resourceful interaction with the outside world,
including synchronous, asynchronous, concurrent, and parallel interaction.
They use a fiber-based concurrency model, with built-in support for
scheduling, fine-grained interruption, structured concurrency, and high
scalability.
To run an Effect value, you need a Runtime, which is a type that is
capable of executing Effect values.
Effect<boolean, never, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<boolean, never, R>R> = import internalinternal.const isSuccess: <A, E, R>(
self: Effect.Effect<A, E, R>
) => Effect.Effect<boolean, never, R>