<E>(error: E): Cause<E>Creates a Cause containing a single Fail reason with the
given typed error.
When to use
Use to construct a cause from an expected typed error.
Example (Creating a fail cause)
import { Cause } from "effect"
const cause = Cause.fail("Something went wrong")
console.log(cause.reasons.length) // 1
console.log(Cause.isFailReason(cause.reasons[0])) // trueexport const const fail: <E>(error: E) => Cause<E>Creates a Cause containing a single Fail reason with the
given typed error.
When to use
Use to construct a cause from an expected typed error.
Example (Creating a fail cause)
import { Cause } from "effect"
const cause = Cause.fail("Something went wrong")
console.log(cause.reasons.length) // 1
console.log(Cause.isFailReason(cause.reasons[0])) // true
fail: <function (type parameter) E in <E>(error: E): Cause<E>E>(error: Eerror: function (type parameter) E in <E>(error: E): Cause<E>E) => interface Cause<out E>A structured representation of how an Effect failed.
When to use
Use to preserve the full structured failure information for an effect instead
of collapsing it to a single error value.
Details
Access the individual failure entries through the reasons array, then
narrow each entry with
isFailReason
,
isDieReason
, or
- Use
hasFails
/
hasDies
/
hasInterrupts
to test
for the presence of specific reason kinds without iterating.
- Use
findError
/
findDefect
to extract the first value
of a given kind.
- Use
combine
to merge two causes.
Cause implements Equal — two causes with the same reasons (by value)
compare as equal.
Example (Creating and inspecting a cause)
import { Cause } from "effect"
const cause = Cause.fail("Something went wrong")
console.log(cause.reasons.length) // 1
console.log(Cause.isFailReason(cause.reasons[0])) // true
Companion namespace for the Cause interface.
Cause<function (type parameter) E in <E>(error: E): Cause<E>E> = import corecore.const causeFail: <E>(
error: E
) => Cause.Cause<E>