(concurrency: number | "unbounded"): <A, E, R>(
self: Effect<A, E, R>
) => Effect<A, E, R>
<A, E, R>(
self: Effect<A, E, R>,
concurrency: number | "unbounded"
): Effect<A, E, R>Sets the concurrency level for parallel operations within an effect.
Example (Setting local concurrency)
import { Console, Effect } from "effect"
const task = (id: number) =>
Effect.gen(function*() {
yield* Console.log(`Task ${id} starting`)
yield* Effect.sleep("100 millis")
yield* Console.log(`Task ${id} completed`)
return id
})
// Run tasks with limited concurrency (max 2 at a time)
const program = Effect.gen(function*() {
const tasks = [1, 2, 3, 4, 5].map(task)
return yield* Effect.all(tasks, { concurrency: 2 })
}).pipe(
Effect.withConcurrency(2)
)
Effect.runPromise(program).then(console.log)
// Tasks will run with max 2 concurrent operations
// [1, 2, 3, 4, 5]export const const withConcurrency: {
(concurrency: number | "unbounded"): <A, E, R>(
self: Effect<A, E, R>
) => Effect<A, E, R>
<A, E, R>(
self: Effect<A, E, R>,
concurrency: number | "unbounded"
): Effect<A, E, R>
}
Sets the concurrency level for parallel operations within an effect.
Example (Setting local concurrency)
import { Console, Effect } from "effect"
const task = (id: number) =>
Effect.gen(function*() {
yield* Console.log(`Task ${id} starting`)
yield* Effect.sleep("100 millis")
yield* Console.log(`Task ${id} completed`)
return id
})
// Run tasks with limited concurrency (max 2 at a time)
const program = Effect.gen(function*() {
const tasks = [1, 2, 3, 4, 5].map(task)
return yield* Effect.all(tasks, { concurrency: 2 })
}).pipe(
Effect.withConcurrency(2)
)
Effect.runPromise(program).then(console.log)
// Tasks will run with max 2 concurrent operations
// [1, 2, 3, 4, 5]
withConcurrency: {
(
concurrency: number | "unbounded"concurrency: number | "unbounded"
): <function (type parameter) A in <A, E, R>(self: Effect<A, E, R>): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<A, E, R>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;
}
self: 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>(self: Effect<A, E, R>): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<A, E, R>R>) => 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>(self: Effect<A, E, R>): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<A, E, R>R>
<function (type parameter) A in <A, E, R>(self: Effect<A, E, R>, concurrency: number | "unbounded"): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>, concurrency: number | "unbounded"): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>, concurrency: number | "unbounded"): Effect<A, E, R>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;
}
self: 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>(self: Effect<A, E, R>, concurrency: number | "unbounded"): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>, concurrency: number | "unbounded"): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>, concurrency: number | "unbounded"): Effect<A, E, R>R>,
concurrency: number | "unbounded"concurrency: number | "unbounded"
): 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>(self: Effect<A, E, R>, concurrency: number | "unbounded"): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>, concurrency: number | "unbounded"): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>, concurrency: number | "unbounded"): Effect<A, E, R>R>
} = import internalinternal.const withConcurrency: {
(concurrency: "unbounded" | number): <A, E, R>(
self: Effect.Effect<A, E, R>
) => Effect.Effect<A, E, R>
<A, E, R>(
self: Effect.Effect<A, E, R>,
concurrency: "unbounded" | number
): Effect.Effect<A, E, R>
}
withConcurrency