<R>(context: Context.Context<R>): <A, E>(
self: Effect<A, E, R>
) => Effect<A, E>
<A, E, R>(self: Effect<A, E, R>, context: Context.Context<R>): Effect<
A,
E
>Runs an effect with the provided context as its complete environment.
When to use
Use when you already have a Context containing every service required by
the effect and want the wrapped effect to run with exactly that context.
Gotchas
setContext replaces the current context for the wrapped effect. Services
from an outer context are not inherited unless they are also present in the
context passed to setContext.
Example (Running with a complete context)
import { Context, Effect } from "effect"
class Config extends Context.Service<Config, {
readonly greeting: string
}>()("Config") {}
const program = Effect.gen(function*() {
const config = yield* Effect.service(Config)
return `${config.greeting}, World!`
})
const context = Context.make(Config, { greeting: "Hello" })
const runnable = Effect.setContext(program, context)
Effect.runPromise(runnable).then(console.log)
// Output: "Hello, World!"export const const setContext: {
<R>(context: Context.Context<R>): <A, E>(
self: Effect<A, E, R>
) => Effect<A, E>
<A, E, R>(
self: Effect<A, E, R>,
context: Context.Context<R>
): Effect<A, E>
}
Runs an effect with the provided context as its complete environment.
When to use
Use when you already have a Context containing every service required by
the effect and want the wrapped effect to run with exactly that context.
Gotchas
setContext replaces the current context for the wrapped effect. Services
from an outer context are not inherited unless they are also present in the
context passed to setContext.
Example (Running with a complete context)
import { Context, Effect } from "effect"
class Config extends Context.Service<Config, {
readonly greeting: string
}>()("Config") {}
const program = Effect.gen(function*() {
const config = yield* Effect.service(Config)
return `${config.greeting}, World!`
})
const context = Context.make(Config, { greeting: "Hello" })
const runnable = Effect.setContext(program, context)
Effect.runPromise(runnable).then(console.log)
// Output: "Hello, World!"
setContext: {
<function (type parameter) R in <R>(context: Context.Context<R>): <A, E>(self: Effect<A, E, R>) => Effect<A, E>R>(context: Context.Context<R>(parameter) context: {
mapUnsafe: ReadonlyMap<string, any>;
mutable: boolean;
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 ContextContext.type Context.Context = /*unresolved*/ anyContext<function (type parameter) R in <R>(context: Context.Context<R>): <A, E>(self: Effect<A, E, R>) => Effect<A, E>R>): <function (type parameter) A in <A, E>(self: Effect<A, E, R>): Effect<A, E>A, function (type parameter) E in <A, E>(self: Effect<A, E, R>): Effect<A, E>E>(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>(self: Effect<A, E, R>): Effect<A, E>A, function (type parameter) E in <A, E>(self: Effect<A, E, R>): Effect<A, E>E, function (type parameter) R in <R>(context: Context.Context<R>): <A, E>(self: Effect<A, E, R>) => Effect<A, E>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>(self: Effect<A, E, R>): Effect<A, E>A, function (type parameter) E in <A, E>(self: Effect<A, E, R>): Effect<A, E>E>
<function (type parameter) A in <A, E, R>(self: Effect<A, E, R>, context: Context.Context<R>): Effect<A, E>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>, context: Context.Context<R>): Effect<A, E>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>, context: Context.Context<R>): Effect<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>, context: Context.Context<R>): Effect<A, E>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>, context: Context.Context<R>): Effect<A, E>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>, context: Context.Context<R>): Effect<A, E>R>, context: Context.Context<R>(parameter) context: {
mapUnsafe: ReadonlyMap<string, any>;
mutable: boolean;
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 ContextContext.type Context.Context = /*unresolved*/ anyContext<function (type parameter) R in <A, E, R>(self: Effect<A, E, R>, context: Context.Context<R>): Effect<A, E>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>, context: Context.Context<R>): Effect<A, E>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>, context: Context.Context<R>): Effect<A, E>E>
} = import internalinternal.const setContext: {
<R>(context: Context.Context<R>): <A, E>(
self: Effect.Effect<A, E, R>
) => Effect.Effect<A, E>
<A, E, R>(
self: Effect.Effect<A, E, R>,
context: Context.Context<R>
): Effect.Effect<A, E>
}