(
n: number,
options?: {
readonly concurrency?: Concurrency | undefined
readonly discard?: false | undefined
}
): <A, E, R>(self: Effect<A, E, R>) => Effect<Array<A>, E, R>
(
n: number,
options: {
readonly concurrency?: Concurrency | undefined
readonly discard: true
}
): <A, E, R>(self: Effect<A, E, R>) => Effect<void, E, R>
<A, E, R>(
self: Effect<A, E, R>,
n: number,
options?: {
readonly concurrency?: Concurrency | undefined
readonly discard?: false | undefined
}
): Effect<Array<A>, E, R>
<A, E, R>(
self: Effect<A, E, R>,
n: number,
options: {
readonly concurrency?: Concurrency | undefined
readonly discard: true
}
): Effect<void, E, R>Performs this effect n times and collects results with Effect.all semantics.
When to use
Use when you want to run the repeated effects immediately, with optional concurrency control or result discarding.
Details
Use concurrency to control parallelism and discard: true to ignore results.
Example (Replicating an effect)
import { Console, Effect } from "effect"
const program = Effect.gen(function*() {
const results = yield* Effect.replicateEffect(3)(Effect.succeed(1))
yield* Console.log(results)
})export const const replicateEffect: {
(
n: number,
options?: {
readonly concurrency?:
| Concurrency
| undefined
readonly discard?: false | undefined
}
): <A, E, R>(
self: Effect<A, E, R>
) => Effect<Array<A>, E, R>
(
n: number,
options: {
readonly concurrency?:
| Concurrency
| undefined
readonly discard: true
}
): <A, E, R>(
self: Effect<A, E, R>
) => Effect<void, E, R>
<A, E, R>(
self: Effect<A, E, R>,
n: number,
options?: {
readonly concurrency?:
| Concurrency
| undefined
readonly discard?: false | undefined
}
): Effect<Array<A>, E, R>
<A, E, R>(
self: Effect<A, E, R>,
n: number,
options: {
readonly concurrency?:
| Concurrency
| undefined
readonly discard: true
}
): Effect<void, E, R>
}
Performs this effect n times and collects results with Effect.all semantics.
When to use
Use when you want to run the repeated effects immediately, with optional
concurrency control or result discarding.
Details
Use concurrency to control parallelism and discard: true to ignore results.
Example (Replicating an effect)
import { Console, Effect } from "effect"
const program = Effect.gen(function*() {
const results = yield* Effect.replicateEffect(3)(Effect.succeed(1))
yield* Console.log(results)
})
replicateEffect: {
(
n: numbern: number,
options: {
readonly concurrency?: Concurrency | undefined
readonly discard?: false | undefined
}
concurrency?: Concurrency | undefinedconcurrency?: type Concurrency = number | "unbounded" | "inherit"Describes the concurrency level for Effect operations that run multiple
effects.
When to use
Use to type options that control how many effects may run at the same time.
Details
number — run at most N effects concurrently."unbounded" — run all effects concurrently with no limit."inherit" — inherit the concurrency from the surrounding context.
Example (Setting concurrency values)
import type { Types } from "effect"
const sequential: Types.Concurrency = 1
const limited: Types.Concurrency = 5
const unbounded: Types.Concurrency = "unbounded"
const inherit: Types.Concurrency = "inherit"
Concurrency | undefined; readonly discard?: false | undefineddiscard?: false | undefined }
): <function (type parameter) A in <A, E, R>(self: Effect<A, E, R>): Effect<Array<A>, E, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<Array<A>, E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<Array<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;
}
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<Array<A>, E, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<Array<A>, E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<Array<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<interface Array<T>Array<function (type parameter) A in <A, E, R>(self: Effect<A, E, R>): Effect<Array<A>, E, R>A>, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<Array<A>, E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<Array<A>, E, R>R>
(
n: numbern: number,
options: {
readonly concurrency?: Concurrency | undefined
readonly discard: true
}
concurrency?: Concurrency | undefinedconcurrency?: type Concurrency = number | "unbounded" | "inherit"Describes the concurrency level for Effect operations that run multiple
effects.
When to use
Use to type options that control how many effects may run at the same time.
Details
number — run at most N effects concurrently."unbounded" — run all effects concurrently with no limit."inherit" — inherit the concurrency from the surrounding context.
Example (Setting concurrency values)
import type { Types } from "effect"
const sequential: Types.Concurrency = 1
const limited: Types.Concurrency = 5
const unbounded: Types.Concurrency = "unbounded"
const inherit: Types.Concurrency = "inherit"
Concurrency | undefined; readonly discard: truediscard: true }
): <function (type parameter) A in <A, E, R>(self: Effect<A, E, R>): Effect<void, E, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<void, E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<void, 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;
}
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<void, E, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<void, E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<void, 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<void, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<void, E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<void, E, R>R>
<function (type parameter) A in <A, E, R>(self: Effect<A, E, R>, n: number, options?: {
readonly concurrency?: Concurrency | undefined;
readonly discard?: false | undefined;
}): Effect<Array<A>, E, R>
function (type parameter) E in <A, E, R>(self: Effect<A, E, R>, n: number, options?: {
readonly concurrency?: Concurrency | undefined;
readonly discard?: false | undefined;
}): Effect<Array<A>, E, R>
function (type parameter) R in <A, E, R>(self: Effect<A, E, R>, n: number, options?: {
readonly concurrency?: Concurrency | undefined;
readonly discard?: false | undefined;
}): Effect<Array<A>, E, 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;
}
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>, n: number, options?: {
readonly concurrency?: Concurrency | undefined;
readonly discard?: false | undefined;
}): Effect<Array<A>, E, R>
function (type parameter) E in <A, E, R>(self: Effect<A, E, R>, n: number, options?: {
readonly concurrency?: Concurrency | undefined;
readonly discard?: false | undefined;
}): Effect<Array<A>, E, R>
function (type parameter) R in <A, E, R>(self: Effect<A, E, R>, n: number, options?: {
readonly concurrency?: Concurrency | undefined;
readonly discard?: false | undefined;
}): Effect<Array<A>, E, R>
n: numbern: number,
options: {
readonly concurrency?: Concurrency | undefined
readonly discard?: false | undefined
}
concurrency?: Concurrency | undefinedconcurrency?: type Concurrency = number | "unbounded" | "inherit"Describes the concurrency level for Effect operations that run multiple
effects.
When to use
Use to type options that control how many effects may run at the same time.
Details
number — run at most N effects concurrently."unbounded" — run all effects concurrently with no limit."inherit" — inherit the concurrency from the surrounding context.
Example (Setting concurrency values)
import type { Types } from "effect"
const sequential: Types.Concurrency = 1
const limited: Types.Concurrency = 5
const unbounded: Types.Concurrency = "unbounded"
const inherit: Types.Concurrency = "inherit"
Concurrency | undefined; readonly discard?: false | undefineddiscard?: false | undefined }
): 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<interface Array<T>Array<function (type parameter) A in <A, E, R>(self: Effect<A, E, R>, n: number, options?: {
readonly concurrency?: Concurrency | undefined;
readonly discard?: false | undefined;
}): Effect<Array<A>, E, R>
function (type parameter) E in <A, E, R>(self: Effect<A, E, R>, n: number, options?: {
readonly concurrency?: Concurrency | undefined;
readonly discard?: false | undefined;
}): Effect<Array<A>, E, R>
function (type parameter) R in <A, E, R>(self: Effect<A, E, R>, n: number, options?: {
readonly concurrency?: Concurrency | undefined;
readonly discard?: false | undefined;
}): Effect<Array<A>, E, R>
function (type parameter) A in <A, E, R>(self: Effect<A, E, R>, n: number, options: {
readonly concurrency?: Concurrency | undefined;
readonly discard: true;
}): Effect<void, E, R>
function (type parameter) E in <A, E, R>(self: Effect<A, E, R>, n: number, options: {
readonly concurrency?: Concurrency | undefined;
readonly discard: true;
}): Effect<void, E, R>
function (type parameter) R in <A, E, R>(self: Effect<A, E, R>, n: number, options: {
readonly concurrency?: Concurrency | undefined;
readonly discard: true;
}): Effect<void, E, 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;
}
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>, n: number, options: {
readonly concurrency?: Concurrency | undefined;
readonly discard: true;
}): Effect<void, E, R>
function (type parameter) E in <A, E, R>(self: Effect<A, E, R>, n: number, options: {
readonly concurrency?: Concurrency | undefined;
readonly discard: true;
}): Effect<void, E, R>
function (type parameter) R in <A, E, R>(self: Effect<A, E, R>, n: number, options: {
readonly concurrency?: Concurrency | undefined;
readonly discard: true;
}): Effect<void, E, R>
n: numbern: number,
options: {
readonly concurrency?: Concurrency | undefined
readonly discard: true
}
concurrency?: Concurrency | undefinedconcurrency?: type Concurrency = number | "unbounded" | "inherit"Describes the concurrency level for Effect operations that run multiple
effects.
When to use
Use to type options that control how many effects may run at the same time.
Details
number — run at most N effects concurrently."unbounded" — run all effects concurrently with no limit."inherit" — inherit the concurrency from the surrounding context.
Example (Setting concurrency values)
import type { Types } from "effect"
const sequential: Types.Concurrency = 1
const limited: Types.Concurrency = 5
const unbounded: Types.Concurrency = "unbounded"
const inherit: Types.Concurrency = "inherit"
Concurrency | undefined; readonly discard: truediscard: true }
): 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<void, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>, n: number, options: {
readonly concurrency?: Concurrency | undefined;
readonly discard: true;
}): Effect<void, E, R>
function (type parameter) R in <A, E, R>(self: Effect<A, E, R>, n: number, options: {
readonly concurrency?: Concurrency | undefined;
readonly discard: true;
}): Effect<void, E, R>
import internalinternal.const replicateEffect: {
(
n: number,
options?: {
readonly concurrency?:
| Concurrency
| undefined
readonly discard?: false | undefined
}
): <A, E, R>(
self: Effect.Effect<A, E, R>
) => Effect.Effect<Array<A>, E, R>
(
n: number,
options: {
readonly concurrency?:
| Concurrency
| undefined
readonly discard: true
}
): <A, E, R>(
self: Effect.Effect<A, E, R>
) => Effect.Effect<void, E, R>
<A, E, R>(
self: Effect.Effect<A, E, R>,
n: number,
options?: {
readonly concurrency?:
| Concurrency
| undefined
readonly discard?: false | undefined
}
): Effect.Effect<Array<A>, E, R>
<A, E, R>(
self: Effect.Effect<A, E, R>,
n: number,
options: {
readonly concurrency?:
| Concurrency
| undefined
readonly discard: true
}
): Effect.Effect<void, E, R>
}