EffectIterator<T>Iterator interface for Effect generators, enabling Effect values to work with generator functions.
When to use
Use when defining or typing [Symbol.iterator]() for values typed as
Effects so yield* can pass their success type back into Effect.gen.
export interface interface EffectIterator<T extends Effect<any, any, any>>Iterator interface for Effect generators, enabling Effect values to work with generator functions.
When to use
Use when defining or typing [Symbol.iterator]() for values typed as
Effects so yield* can pass their success type back into Effect.gen.
EffectIterator<function (type parameter) T in EffectIterator<T extends Effect<any, any, any>>T extends 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<any, any, any>> {
function EffectIterator(...args: ReadonlyArray<any>): IteratorResult<T, Success<T>>next(
...args: readonly any[]args: interface ReadonlyArray<T>ReadonlyArray<any>
): type IteratorResult<T, TReturn = any> =
| IteratorYieldResult<T>
| IteratorReturnResult<TReturn>
function (type parameter) T in EffectIterator<T extends Effect<any, any, any>>T, type Success<T> = T extends Effect<
infer _A,
infer _E,
infer _R
>
? _A
: never
Extracts the success type from an Effect.
When to use
Use to derive the value produced by an existing effect when declaring
reusable type aliases, service interfaces, or function signatures.
Success<function (type parameter) T in EffectIterator<T extends Effect<any, any, any>>T>>
}