<A, E>(self: Exit<A, E>): Exit<void, E>Discards the success value of an Exit, replacing it with void.
When to use
Use when you need to discard a successful Exit value while preserving
whether the Exit succeeded or failed.
Details
Failures pass through unchanged.
Allocates a new Exit if successful.
Example (Discarding the success value)
import { Exit } from "effect"
const exit = Exit.succeed(42)
const voided = Exit.asVoid(exit)
console.log(Exit.isSuccess(voided)) // trueexport const const asVoid: <A, E>(
self: Exit<A, E>
) => Exit<void, E>
Discards the success value of an Exit, replacing it with void.
When to use
Use when you need to discard a successful Exit value while preserving
whether the Exit succeeded or failed.
Details
Failures pass through unchanged.
Allocates a new Exit if successful.
Example (Discarding the success value)
import { Exit } from "effect"
const exit = Exit.succeed(42)
const voided = Exit.asVoid(exit)
console.log(Exit.isSuccess(voided)) // true
asVoid: <function (type parameter) A in <A, E>(self: Exit<A, E>): Exit<void, E>A, function (type parameter) E in <A, E>(self: Exit<A, E>): Exit<void, E>E>(self: Exit<A, E>self: type Exit<A, E = never> = Success<A, E> | Failure<A, E>Represents the result of an Effect computation.
When to use
Use when you need to synchronously inspect whether an Effect computation
succeeded or failed.
Details
An Exit<A, E> is either Success<A, E> containing a value of type A, or
Failure<A, E> containing a Cause<E> describing why the computation
failed.
Since Exit is also an Effect, you can yield it inside Effect.gen.
Example (Pattern matching on an Exit)
import { Exit } from "effect"
const success: Exit.Exit<number> = Exit.succeed(42)
const failure: Exit.Exit<number, string> = Exit.fail("error")
const result = Exit.match(success, {
onSuccess: (value) => `Got value: ${value}`,
onFailure: (cause) => `Got error: ${cause}`
})
Namespace containing helper types shared by Exit values.
When to use
Use to reference helper types that describe the shared structure of Exit
values.
Exit<function (type parameter) A in <A, E>(self: Exit<A, E>): Exit<void, E>A, function (type parameter) E in <A, E>(self: Exit<A, E>): Exit<void, E>E>) => type Exit<A, E = never> = Success<A, E> | Failure<A, E>Represents the result of an Effect computation.
When to use
Use when you need to synchronously inspect whether an Effect computation
succeeded or failed.
Details
An Exit<A, E> is either Success<A, E> containing a value of type A, or
Failure<A, E> containing a Cause<E> describing why the computation
failed.
Since Exit is also an Effect, you can yield it inside Effect.gen.
Example (Pattern matching on an Exit)
import { Exit } from "effect"
const success: Exit.Exit<number> = Exit.succeed(42)
const failure: Exit.Exit<number, string> = Exit.fail("error")
const result = Exit.match(success, {
onSuccess: (value) => `Got value: ${value}`,
onFailure: (cause) => `Got error: ${cause}`
})
Namespace containing helper types shared by Exit values.
When to use
Use to reference helper types that describe the shared structure of Exit
values.
Exit<void, function (type parameter) E in <A, E>(self: Exit<A, E>): Exit<void, E>E> = import effecteffect.const exitAsVoid: <A, E>(
self: Exit.Exit<A, E>
) => Exit.Exit<void, E>