<In>(predicate: Predicate<In>): Sink<boolean, In, In>A sink that returns whether an element satisfies the specified predicate.
When to use
Use to reduce a stream to a boolean that is true when any input satisfies a pure predicate.
export const const some: <In>(
predicate: Predicate<In>
) => Sink<boolean, In, In>
A sink that returns whether an element satisfies the specified predicate.
When to use
Use to reduce a stream to a boolean that is true when any input satisfies a
pure predicate.
some = <function (type parameter) In in <In>(predicate: Predicate<In>): Sink<boolean, In, In>In>(predicate: Predicate<In>predicate: import PredicatePredicate<function (type parameter) In in <In>(predicate: Predicate<In>): Sink<boolean, In, In>In>): 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<boolean, function (type parameter) In in <In>(predicate: Predicate<In>): Sink<boolean, In, In>In, function (type parameter) In in <In>(predicate: Predicate<In>): Sink<boolean, In, In>In> =>
const fold: <S, In, E = never, R = never>(
s: LazyArg<S>,
contFn: Predicate<S>,
f: (s: S, input: In) => Effect.Effect<S, E, R>
) => Sink<S, In, In, E, R>
A sink that folds its inputs with the provided function, termination
predicate and initial state.
When to use
Use to accumulate stream input element by element with an effectful step and
stop based on the accumulated state.
Details
The initial state is evaluated lazily. Each input element is folded with the
effectful function, and the sink continues while contFn returns true. If
the sink stops in the middle of a pulled array, the remaining elements from
that array are returned as leftovers.
fold(
import constFalseconstFalse,
(b: anyb) => !b: anyb,
(_: boolean_, a: Ina) => import EffectEffect.succeed(predicate: Predicate<In>predicate(a: Ina))
)