Effect<AbortSignal, never, Scope>Creates an AbortSignal that is managed by the provided scope.
When to use
Use to obtain a scope-managed AbortSignal for APIs that accept cancellation
through a signal.
Details
Each acquisition creates a fresh AbortController. Closing the owning scope
runs a finalizer that aborts the controller and the effect succeeds with the
controller's signal.
Gotchas
The signal is aborted when its owning scope closes, so avoid keeping it for work that outlives that scope.
export const const abortSignal: Effect<
AbortSignal,
never,
Scope
>
const abortSignal: {
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;
}
Creates an AbortSignal that is managed by the provided scope.
When to use
Use to obtain a scope-managed AbortSignal for APIs that accept cancellation
through a signal.
Details
Each acquisition creates a fresh AbortController. Closing the owning scope
runs a finalizer that aborts the controller and the effect succeeds with the
controller's signal.
Gotchas
The signal is aborted when its owning scope closes, so avoid keeping it for
work that outlives that scope.
abortSignal: 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<AbortSignal, never, Scope> = import internalinternal.const abortSignal: Effect.Effect<
AbortSignal,
never,
Scope.Scope
>
const abortSignal: {
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;
}