<A, E, R>(effect: Effect.Effect<A, E, R>): Sink<A, unknown, never, E, R>Creates a sink that ignores upstream input and completes with the success value of the provided effect.
Details
If the effect fails, the sink fails with the same error.
export const const fromEffect: <A, E, R>(
effect: Effect.Effect<A, E, R>
) => Sink<A, unknown, never, E, R>
Creates a sink that ignores upstream input and completes with the success
value of the provided effect.
Details
If the effect fails, the sink fails with the same error.
fromEffect = <function (type parameter) A in <A, E, R>(effect: Effect.Effect<A, E, R>): Sink<A, unknown, never, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect.Effect<A, E, R>): Sink<A, unknown, never, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect.Effect<A, E, R>): Sink<A, unknown, never, E, R>R>(
effect: Effect.Effect<A, E, R>(parameter) effect: {
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;
}
import EffectEffect.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>(effect: Effect.Effect<A, E, R>): Sink<A, unknown, never, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect.Effect<A, E, R>): Sink<A, unknown, never, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect.Effect<A, E, R>): Sink<A, unknown, never, E, R>R>
): interface Sink<out A, in In = unknown, out L = never, out E = never, out R = never>A Sink<A, In, L, E, R> is used to consume elements produced by a Stream.
You can think of a sink as a function that will consume a variable amount of
In elements (could be 0, 1, or many), might fail with an error of type E,
and will eventually yield a value of type A together with a remainder of
type L (i.e. any leftovers).
Example (Running a sink with a stream)
import { Effect, Sink, Stream } from "effect"
// Create a simple sink that always succeeds with a value
const sink: Sink.Sink<number> = Sink.succeed(42)
// Use the sink to consume a stream
const stream = Stream.make(1, 2, 3)
const program = Stream.run(stream, sink)
Effect.runPromise(program).then(console.log)
// Output: 42
Namespace containing types and interfaces for Sink variance and type relationships.
Sink<function (type parameter) A in <A, E, R>(effect: Effect.Effect<A, E, R>): Sink<A, unknown, never, E, R>A, unknown, never, function (type parameter) E in <A, E, R>(effect: Effect.Effect<A, E, R>): Sink<A, unknown, never, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect.Effect<A, E, R>): Sink<A, unknown, never, E, R>R> => const fromEffectEnd: <A, E, R, L = never>(
effect: Effect.Effect<End<A, L>, E, R>
) => Sink<A, unknown, L, E, R>
Creates a sink that ignores upstream input and completes from an effect that
already returns an End.
When to use
Use when you need to create a sink from an effect that returns both the sink
result value and optional leftovers.
fromEffectEnd(import EffectEffect.const map: {
<A, B>(f: (a: A) => B): <E, R>(
self: Effect<A, E, R>
) => Effect<B, E, R>
<A, E, R, B>(
self: Effect<A, E, R>,
f: (a: A) => B
): Effect<B, E, R>
}
effect: Effect.Effect<A, E, R>(parameter) effect: {
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;
}
a: Aa) => [a: Aa]))