<A, E, R>(self: Effect<A, E, R>): Effect<A, never, R>Converts typed failures from the error channel into defects, removing the error type from the returned effect.
When to use
Use when you need to turn an Effect typed failure that represents an
unrecoverable bug or invalid state into a defect.
Example (Converting typed failures into defects)
import { Data, Effect } from "effect"
class DivideByZeroError extends Data.TaggedError("DivideByZeroError")<{}> {}
const divide = (a: number, b: number) =>
b === 0
? Effect.fail(new DivideByZeroError())
: Effect.succeed(a / b)
// ┌─── Effect<number, never, never>
// ▼
const program = Effect.orDie(divide(1, 0))
Effect.runPromise(program).catch(console.error)
// Output:
// (FiberFailure) DivideByZeroError
// ...stack trace...export const const orDie: <A, E, R>(
self: Effect<A, E, R>
) => Effect<A, never, R>
Converts typed failures from the error channel into defects, removing the
error type from the returned effect.
When to use
Use when you need to turn an Effect typed failure that represents an
unrecoverable bug or invalid state into a defect.
Example (Converting typed failures into defects)
import { Data, Effect } from "effect"
class DivideByZeroError extends Data.TaggedError("DivideByZeroError")<{}> {}
const divide = (a: number, b: number) =>
b === 0
? Effect.fail(new DivideByZeroError())
: Effect.succeed(a / b)
// ┌─── Effect<number, never, never>
// ▼
const program = Effect.orDie(divide(1, 0))
Effect.runPromise(program).catch(console.error)
// Output:
// (FiberFailure) DivideByZeroError
// ...stack trace...
orDie: <function (type parameter) A in <A, E, R>(self: Effect<A, E, R>): Effect<A, never, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<A, never, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<A, 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<A, never, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<A, never, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<A, 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<function (type parameter) A in <A, E, R>(self: Effect<A, E, R>): Effect<A, never, R>A, never, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<A, never, R>R> = import internalinternal.const orDie: <A, E, R>(
self: Effect.Effect<A, E, R>
) => Effect.Effect<A, never, R>