<A, E, XE extends E, XA extends A>(
fiber: Fiber.Fiber<XA, XE>,
options?:
| { readonly propagateInterruption?: boolean | undefined }
| undefined
): (self: FiberSet<A, E>) => Effect.Effect<void>
<A, E, XE extends E, XA extends A>(
self: FiberSet<A, E>,
fiber: Fiber.Fiber<XA, XE>,
options?:
| { readonly propagateInterruption?: boolean | undefined }
| undefined
): Effect.Effect<void>Adds a fiber to the FiberSet. When the fiber completes, it will be removed.
Example (Adding a fiber)
import { Effect, FiberSet } from "effect"
const program = Effect.gen(function*() {
const set = yield* FiberSet.make()
const fiber = yield* Effect.forkChild(Effect.succeed("hello"))
// Add the fiber to the set
yield* FiberSet.add(set, fiber)
// The fiber is now managed by the set
console.log(yield* FiberSet.size(set)) // 1
})combinators
Source effect/FiberSet.ts:36224 lines
export const const add: {
<A, E, XE extends E, XA extends A>(
fiber: Fiber.Fiber<XA, XE>,
options?:
| {
readonly propagateInterruption?:
| boolean
| undefined
}
| undefined
): (self: FiberSet<A, E>) => Effect.Effect<void>
<A, E, XE extends E, XA extends A>(
self: FiberSet<A, E>,
fiber: Fiber.Fiber<XA, XE>,
options?:
| {
readonly propagateInterruption?:
| boolean
| undefined
}
| undefined
): Effect.Effect<void>
}
Adds a fiber to the FiberSet. When the fiber completes, it will be removed.
Example (Adding a fiber)
import { Effect, FiberSet } from "effect"
const program = Effect.gen(function*() {
const set = yield* FiberSet.make()
const fiber = yield* Effect.forkChild(Effect.succeed("hello"))
// Add the fiber to the set
yield* FiberSet.add(set, fiber)
// The fiber is now managed by the set
console.log(yield* FiberSet.size(set)) // 1
})
add: {
<function (type parameter) A in <A, E, XE extends E, XA extends A>(fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): (self: FiberSet<A, E>) => Effect.Effect<void>
function (type parameter) E in <A, E, XE extends E, XA extends A>(fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): (self: FiberSet<A, E>) => Effect.Effect<void>
function (type parameter) XE in <A, E, XE extends E, XA extends A>(fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): (self: FiberSet<A, E>) => Effect.Effect<void>
function (type parameter) E in <A, E, XE extends E, XA extends A>(fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): (self: FiberSet<A, E>) => Effect.Effect<void>
function (type parameter) XA in <A, E, XE extends E, XA extends A>(fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): (self: FiberSet<A, E>) => Effect.Effect<void>
function (type parameter) A in <A, E, XE extends E, XA extends A>(fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): (self: FiberSet<A, E>) => Effect.Effect<void>
fiber: Fiber.Fiber<XA, XE>(parameter) fiber: {
id: number;
currentOpCount: number;
getRef: <A>(ref: Context.Reference<A>) => A;
context: Context.Context<never>;
setContext: (context: Context.Context<never>) => void;
currentScheduler: Scheduler;
currentDispatcher: SchedulerDispatcher;
currentSpan: AnySpan | undefined;
currentLogLevel: LogLevel;
minimumLogLevel: LogLevel;
currentStackFrame: StackFrame | undefined;
maxOpsBeforeYield: number;
currentPreventYield: boolean;
addObserver: (cb: (exit: Exit<A, E>) => void) => () => void;
interruptUnsafe: (fiberId?: number | undefined, annotations?: Context.Context<never> | undefined) => void;
pollUnsafe: () => Exit<A, E> | undefined;
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; <…;
}
import FiberFiber.type Fiber.Fiber = /*unresolved*/ anyFiber<function (type parameter) XA in <A, E, XE extends E, XA extends A>(fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): (self: FiberSet<A, E>) => Effect.Effect<void>
function (type parameter) XE in <A, E, XE extends E, XA extends A>(fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): (self: FiberSet<A, E>) => Effect.Effect<void>
options: | {
readonly propagateInterruption?:
| boolean
| undefined
}
| undefined
propagateInterruption?: boolean | undefinedpropagateInterruption?: boolean | undefined
} | undefined
): (self: FiberSet<A, E>(parameter) self: {
deferred: Deferred.Deferred<void, unknown>;
state: { readonly _tag: "Open"; readonly backing: Set<Fiber.Fiber<A, E>> } | { readonly _tag: "Closed" };
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 FiberSet<out A = unknown, out E = unknown>A FiberSet is a collection of fibers that can be managed together.
When the associated Scope is closed, all fibers in the set will be interrupted.
Example (Managing fibers in a set)
import { Effect, FiberSet } from "effect"
const program = Effect.gen(function*() {
const set = yield* FiberSet.make<string, string>()
// Add fibers to the set
yield* FiberSet.run(set, Effect.succeed("hello"))
yield* FiberSet.run(set, Effect.succeed("world"))
// Wait for all fibers to complete
yield* FiberSet.awaitEmpty(set)
})
FiberSet<function (type parameter) A in <A, E, XE extends E, XA extends A>(fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): (self: FiberSet<A, E>) => Effect.Effect<void>
function (type parameter) E in <A, E, XE extends E, XA extends A>(fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): (self: FiberSet<A, E>) => Effect.Effect<void>
import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<void>
<function (type parameter) A in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) E in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) XE in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) E in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) XA in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) A in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
self: FiberSet<A, E>(parameter) self: {
deferred: Deferred.Deferred<void, unknown>;
state: { readonly _tag: "Open"; readonly backing: Set<Fiber.Fiber<A, E>> } | { readonly _tag: "Closed" };
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 FiberSet<out A = unknown, out E = unknown>A FiberSet is a collection of fibers that can be managed together.
When the associated Scope is closed, all fibers in the set will be interrupted.
Example (Managing fibers in a set)
import { Effect, FiberSet } from "effect"
const program = Effect.gen(function*() {
const set = yield* FiberSet.make<string, string>()
// Add fibers to the set
yield* FiberSet.run(set, Effect.succeed("hello"))
yield* FiberSet.run(set, Effect.succeed("world"))
// Wait for all fibers to complete
yield* FiberSet.awaitEmpty(set)
})
FiberSet<function (type parameter) A in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) E in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
fiber: Fiber.Fiber<XA, XE>(parameter) fiber: {
id: number;
currentOpCount: number;
getRef: <A>(ref: Context.Reference<A>) => A;
context: Context.Context<never>;
setContext: (context: Context.Context<never>) => void;
currentScheduler: Scheduler;
currentDispatcher: SchedulerDispatcher;
currentSpan: AnySpan | undefined;
currentLogLevel: LogLevel;
minimumLogLevel: LogLevel;
currentStackFrame: StackFrame | undefined;
maxOpsBeforeYield: number;
currentPreventYield: boolean;
addObserver: (cb: (exit: Exit<A, E>) => void) => () => void;
interruptUnsafe: (fiberId?: number | undefined, annotations?: Context.Context<never> | undefined) => void;
pollUnsafe: () => Exit<A, E> | undefined;
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; <…;
}
import FiberFiber.type Fiber.Fiber = /*unresolved*/ anyFiber<function (type parameter) XA in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) XE in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
options: | {
readonly propagateInterruption?:
| boolean
| undefined
}
| undefined
propagateInterruption?: boolean | undefinedpropagateInterruption?: boolean | undefined
} | undefined
): import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<void>
} = dual<(...args: Array<any>) => any, <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined) => Effect.Effect<void>>(isDataFirst: (args: IArguments) => boolean, body: <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined) => Effect.Effect<void>): ((...args: Array<any>) => any) & (<A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined) => Effect.Effect<void>) (+1 overload)
Creates a function that can be called in data-first style or data-last
(pipe-friendly) style.
When to use
Use to expose one implementation through both direct and pipe-friendly
call styles.
Details
Pass either the arity of the uncurried function or a predicate that decides
whether the current call is data-first. Arity is the common case. Use a
predicate when optional arguments make arity ambiguous.
Example (Selecting data-first or data-last style by arity)
import { Function, pipe } from "effect"
const sum = Function.dual<
(that: number) => (self: number) => number,
(self: number, that: number) => number
>(2, (self, that) => self + that)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
Example (Defining overloads with call signatures)
import { Function, pipe } from "effect"
const sum: {
(that: number): (self: number) => number
(self: number, that: number): number
} = Function.dual(2, (self: number, that: number): number => self + that)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
Example (Selecting data-first or data-last style with a predicate)
import { Function, pipe } from "effect"
const sum = Function.dual<
(that: number) => (self: number) => number,
(self: number, that: number) => number
>(
(args) => args.length === 2,
(self, that) => self + that
)
console.log(sum(2, 3)) // 5
console.log(pipe(2, sum(3))) // 5
dual(
(args: IArgumentsargs) => const isFiberSet: (
u: unknown
) => u is FiberSet<unknown, unknown>
Checks whether a value is a FiberSet.
Example (Checking if a value is a FiberSet)
import { Effect, FiberSet } from "effect"
Effect.gen(function*() {
const set = yield* FiberSet.make()
console.log(FiberSet.isFiberSet(set)) // true
console.log(FiberSet.isFiberSet({})) // false
})
isFiberSet(args: IArgumentsargs[0]),
<function (type parameter) A in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) E in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) XE in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) E in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) XA in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) A in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
self: FiberSet<A, E>(parameter) self: {
deferred: Deferred.Deferred<void, unknown>;
state: { readonly _tag: "Open"; readonly backing: Set<Fiber.Fiber<A, E>> } | { readonly _tag: "Closed" };
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 FiberSet<out A = unknown, out E = unknown>A FiberSet is a collection of fibers that can be managed together.
When the associated Scope is closed, all fibers in the set will be interrupted.
Example (Managing fibers in a set)
import { Effect, FiberSet } from "effect"
const program = Effect.gen(function*() {
const set = yield* FiberSet.make<string, string>()
// Add fibers to the set
yield* FiberSet.run(set, Effect.succeed("hello"))
yield* FiberSet.run(set, Effect.succeed("world"))
// Wait for all fibers to complete
yield* FiberSet.awaitEmpty(set)
})
FiberSet<function (type parameter) A in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) E in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
fiber: Fiber.Fiber<XA, XE>(parameter) fiber: {
id: number;
currentOpCount: number;
getRef: <A>(ref: Context.Reference<A>) => A;
context: Context.Context<never>;
setContext: (context: Context.Context<never>) => void;
currentScheduler: Scheduler;
currentDispatcher: SchedulerDispatcher;
currentSpan: AnySpan | undefined;
currentLogLevel: LogLevel;
minimumLogLevel: LogLevel;
currentStackFrame: StackFrame | undefined;
maxOpsBeforeYield: number;
currentPreventYield: boolean;
addObserver: (cb: (exit: Exit<A, E>) => void) => () => void;
interruptUnsafe: (fiberId?: number | undefined, annotations?: Context.Context<never> | undefined) => void;
pollUnsafe: () => Exit<A, E> | undefined;
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; <…;
}
import FiberFiber.type Fiber.Fiber = /*unresolved*/ anyFiber<function (type parameter) XA in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
function (type parameter) XE in <A, E, XE extends E, XA extends A>(self: FiberSet<A, E>, fiber: Fiber.Fiber<XA, XE>, options?: {
readonly propagateInterruption?: boolean | undefined;
} | undefined): Effect.Effect<void>
options: | {
readonly propagateInterruption?:
| boolean
| undefined
}
| undefined
propagateInterruption?: boolean | undefinedpropagateInterruption?: boolean | undefined
} | undefined
): import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<void> => import EffectEffect.sync(() => const addUnsafe: {
<A, E, XE extends E, XA extends A>(
fiber: Fiber.Fiber<XA, XE>,
options?:
| {
readonly propagateInterruption?:
| boolean
| undefined
}
| undefined
): (self: FiberSet<A, E>) => void
<A, E, XE extends E, XA extends A>(
self: FiberSet<A, E>,
fiber: Fiber.Fiber<XA, XE>,
options?:
| {
readonly propagateInterruption?:
| boolean
| undefined
}
| undefined
): void
}
self: FiberSet<A, E>(parameter) self: {
deferred: Deferred.Deferred<void, unknown>;
state: { readonly _tag: "Open"; readonly backing: Set<Fiber.Fiber<A, E>> } | { readonly _tag: "Closed" };
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;
}
fiber: Fiber.Fiber<XA, XE>(parameter) fiber: {
id: number;
currentOpCount: number;
getRef: <A>(ref: Context.Reference<A>) => A;
context: Context.Context<never>;
setContext: (context: Context.Context<never>) => void;
currentScheduler: Scheduler;
currentDispatcher: SchedulerDispatcher;
currentSpan: AnySpan | undefined;
currentLogLevel: LogLevel;
minimumLogLevel: LogLevel;
currentStackFrame: StackFrame | undefined;
maxOpsBeforeYield: number;
currentPreventYield: boolean;
addObserver: (cb: (exit: Exit<A, E>) => void) => () => void;
interruptUnsafe: (fiberId?: number | undefined, annotations?: Context.Context<never> | undefined) => void;
pollUnsafe: () => Exit<A, E> | undefined;
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; <…;
}
options: | {
readonly propagateInterruption?:
| boolean
| undefined
}
| undefined