<E, A2, E2, R2>(
f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>
): <A, R>(
self: Effect<A, E, R>
) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>
<A, R, E, A2, E2, R2>(
self: Effect<A, E, R>,
f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>
): Effect<A | A2, ExcludeDone<E> | E2, R | R2>Handles Cause.Done failures in an effect while leaving ordinary failures
in the error channel.
When to use
Use to recover from a Cause.Done completion signal in an effect, such as
turning a pull leftover value into a successful recovery effect while
preserving ordinary failures.
Details
The handler receives the done leftover value and may recover with a new effect. Non-done errors are preserved.
Source effect/Pull.ts:15713 lines
export const const catchDone: {
<E, A2, E2, R2>(
f: (
leftover: Cause.Done.Extract<E>
) => Effect<A2, E2, R2>
): <A, R>(
self: Effect<A, E, R>
) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>
<A, R, E, A2, E2, R2>(
self: Effect<A, E, R>,
f: (
leftover: Cause.Done.Extract<E>
) => Effect<A2, E2, R2>
): Effect<A | A2, ExcludeDone<E> | E2, R | R2>
}
Handles Cause.Done failures in an effect while leaving ordinary failures
in the error channel.
When to use
Use to recover from a Cause.Done completion signal in an effect, such as
turning a pull leftover value into a successful recovery effect while
preserving ordinary failures.
Details
The handler receives the done leftover value and may recover with a new
effect. Non-done errors are preserved.
catchDone: {
<function (type parameter) E in <E, A2, E2, R2>(f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): <A, R>(self: Effect<A, E, R>) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>E, function (type parameter) A2 in <E, A2, E2, R2>(f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): <A, R>(self: Effect<A, E, R>) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>A2, function (type parameter) E2 in <E, A2, E2, R2>(f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): <A, R>(self: Effect<A, E, R>) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>E2, function (type parameter) R2 in <E, A2, E2, R2>(f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): <A, R>(self: Effect<A, E, R>) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>R2>(f: (
leftover: Cause.Done.Extract<E>
) => Effect<A2, E2, R2>
leftover: Cause.Done.Extract<E>leftover: import CauseCause.declareDone.type Cause.Done.Extract = /*unresolved*/ anyExtract<function (type parameter) E in <E, A2, E2, R2>(f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): <A, R>(self: Effect<A, E, R>) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>E>) => import EffectEffect<function (type parameter) A2 in <E, A2, E2, R2>(f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): <A, R>(self: Effect<A, E, R>) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>A2, function (type parameter) E2 in <E, A2, E2, R2>(f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): <A, R>(self: Effect<A, E, R>) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>E2, function (type parameter) R2 in <E, A2, E2, R2>(f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): <A, R>(self: Effect<A, E, R>) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>R2>): <function (type parameter) A in <A, R>(self: Effect<A, E, R>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A, function (type parameter) R in <A, R>(self: Effect<A, E, R>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R>(
self: Effect<A, E, R>(parameter) self: {
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<function (type parameter) A in <A, R>(self: Effect<A, E, R>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A, function (type parameter) E in <E, A2, E2, R2>(f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): <A, R>(self: Effect<A, E, R>) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>E, function (type parameter) R in <A, R>(self: Effect<A, E, R>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R>
) => import EffectEffect<function (type parameter) A in <A, R>(self: Effect<A, E, R>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A | function (type parameter) A2 in <E, A2, E2, R2>(f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): <A, R>(self: Effect<A, E, R>) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>A2, type ExcludeDone<E> =
E extends Cause.Done<any> ? never : E
Excludes Cause.Done completion signals from an error type union.
When to use
Use to describe the ordinary error type that remains after Cause.Done
completion signals have been handled or filtered out of an error union.
ExcludeDone<function (type parameter) E in <E, A2, E2, R2>(f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): <A, R>(self: Effect<A, E, R>) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>E> | function (type parameter) E2 in <E, A2, E2, R2>(f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): <A, R>(self: Effect<A, E, R>) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>E2, function (type parameter) R in <A, R>(self: Effect<A, E, R>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R | function (type parameter) R2 in <E, A2, E2, R2>(f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): <A, R>(self: Effect<A, E, R>) => Effect<A | A2, ExcludeDone<E> | E2, R | R2>R2>
<function (type parameter) A in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A, function (type parameter) R in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R, function (type parameter) E in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E, function (type parameter) A2 in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A2, function (type parameter) E2 in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E2, function (type parameter) R2 in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R2>(
self: Effect<A, E, R>(parameter) self: {
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<function (type parameter) A in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A, function (type parameter) E in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E, function (type parameter) R in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R>,
f: (
leftover: Cause.Done.Extract<E>
) => Effect<A2, E2, R2>
leftover: Cause.Done.Extract<E>leftover: import CauseCause.declareDone.type Cause.Done.Extract = /*unresolved*/ anyExtract<function (type parameter) E in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E>) => import EffectEffect<function (type parameter) A2 in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A2, function (type parameter) E2 in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E2, function (type parameter) R2 in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R2>
): import EffectEffect<function (type parameter) A in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A | function (type parameter) A2 in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A2, type ExcludeDone<E> =
E extends Cause.Done<any> ? never : E
Excludes Cause.Done completion signals from an error type union.
When to use
Use to describe the ordinary error type that remains after Cause.Done
completion signals have been handled or filtered out of an error union.
ExcludeDone<function (type parameter) E in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E> | function (type parameter) E2 in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E2, function (type parameter) R in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R | function (type parameter) R2 in <A, R, E, A2, E2, R2>(self: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R2>
} = import dualdual(2, <function (type parameter) A in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A, function (type parameter) R in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R, function (type parameter) E in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E, function (type parameter) A2 in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A2, function (type parameter) E2 in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E2, function (type parameter) R2 in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R2>(
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<function (type parameter) A in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A, function (type parameter) E in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E, function (type parameter) R in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R>,
f: (
leftover: Cause.Done.Extract<E>
) => Effect<A2, E2, R2>
leftover: Cause.Done.Extract<E>leftover: import CauseCause.declareDone.type Cause.Done.Extract = /*unresolved*/ anyExtract<function (type parameter) E in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E>) => import EffectEffect<function (type parameter) A2 in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A2, function (type parameter) E2 in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E2, function (type parameter) R2 in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R2>
): import EffectEffect<function (type parameter) A in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A | function (type parameter) A2 in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>A2, type ExcludeDone<E> =
E extends Cause.Done<any> ? never : E
Excludes Cause.Done completion signals from an error type union.
When to use
Use to describe the ordinary error type that remains after Cause.Done
completion signals have been handled or filtered out of an error union.
ExcludeDone<function (type parameter) E in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E> | function (type parameter) E2 in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>E2, function (type parameter) R in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R | function (type parameter) R2 in <A, R, E, A2, E2, R2>(effect: Effect<A, E, R>, f: (leftover: Cause.Done.Extract<E>) => Effect<A2, E2, R2>): Effect<A | A2, ExcludeDone<E> | E2, R | R2>R2> =>
import internalEffectinternalEffect.const catchCauseFilter: {
<E, B, E2, R2, EB, X extends Cause.Cause<any>>(
filter: Filter.Filter<Cause.Cause<E>, EB, X>,
f: (
failure: EB,
cause: Cause.Cause<E>
) => Effect.Effect<B, E2, R2>
): <A, R>(
self: Effect.Effect<A, E, R>
) => Effect.Effect<
A | B,
Cause.Cause.Error<X> | E2,
R | R2
>
<
A,
E,
R,
B,
E2,
R2,
EB,
X extends Cause.Cause<any>
>(
self: Effect.Effect<A, E, R>,
filter: Filter.Filter<Cause.Cause<E>, EB, X>,
f: (
failure: EB,
cause: Cause.Cause<E>
) => Effect.Effect<B, E2, R2>
): Effect.Effect<
A | B,
Cause.Cause.Error<X> | E2,
R | R2
>
}
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;
}
const filterDoneLeftover: <E>(
cause: Cause.Cause<E>
) => Result.Result<
Cause.Done.Extract<E>,
Cause.Cause<ExcludeDone<E>>
>
Filters a Cause to extract the leftover value from done errors.
When to use
Use to extract only the leftover value carried by a Cause.Done completion
signal.
filterDoneLeftover as any, (l: anyl: any) => f: (
leftover: Cause.Done.Extract<E>
) => Effect<A2, E2, R2>
l: anyl)) as any)Referenced by 32 symbols
Channel.concatWithChannel.mapDoneEffectChannel.onEndChannel.orElseIfEmptyChannel.repeatChannel.retryQueue.collectSchedule.andThenResultSink.drainSink.foldSink.foldArraySink.forEachArraySink.forEachWhileArraySink.fromChannelSink.fromQueueSink.reduceArraySink.reduceWhileSink.reduceWhileArraySink.reduceWhileArrayEffectSink.reduceWhileEffectSink.takeSink.takeWhileSink.takeWhileEffectSink.takeWhileFilterSink.takeWhileFilterEffectStream.aggregateWithinStream.fromScheduleStream.groupAdjacentByStream.interleaveWithStream.rechunkStream.repeatElementsStream.tapSink