<A, E>(self: Scope, exit_: Exit<A, E>):
| Effect<void, never, never>
| undefinedCloses a scope unsafely with the provided exit value.
When to use
Use when implementing lower-level scope machinery that must transition a
scope to Closed immediately and can run the returned finalizer effect when
one is produced.
Details
Returns an effect that runs registered finalizers, or undefined when the
scope was already closed or no finalizers need to run.
Gotchas
Ignoring the returned effect skips registered finalizers.
export const const closeUnsafe: <A, E>(
self: Scope,
exit_: Exit<A, E>
) => Effect<void, never, never> | undefined
Closes a scope unsafely with the provided exit value.
When to use
Use when implementing lower-level scope machinery that must transition a
scope to Closed immediately and can run the returned finalizer effect when
one is produced.
Details
Returns an effect that runs registered finalizers, or undefined when the
scope was already closed or no finalizers need to run.
Gotchas
Ignoring the returned effect skips registered finalizers.
closeUnsafe: <function (type parameter) A in <A, E>(self: Scope, exit_: Exit<A, E>): Effect<void, never, never> | undefinedA, function (type parameter) E in <A, E>(self: Scope, exit_: Exit<A, E>): Effect<void, never, never> | undefinedE>(self: Scope(parameter) self: {
strategy: "sequential" | "parallel";
state: State.Open | State.Closed | State.Empty;
}
exit_: Exit<A, E>exit_: 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: Scope, exit_: Exit<A, E>): Effect<void, never, never> | undefinedA, function (type parameter) E in <A, E>(self: Scope, exit_: Exit<A, E>): Effect<void, never, never> | undefinedE>) => 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<void, never, never> | undefined =
import effecteffect.const scopeCloseUnsafe: <A, E>(
self: Scope.Scope,
exit_: Exit.Exit<A, E>
) => Effect.Effect<void, never, never> | undefined