(enabled: boolean): <A, E, R>(effect: Effect<A, E, R>) => Effect<A, E, R>
<A, E, R>(effect: Effect<A, E, R>, enabled: boolean): Effect<A, E, R>Enables or disables tracer timing for the given Effect.
Example (Enabling or disabling tracing timing)
import { Effect } from "effect"
Effect.succeed(42).pipe(
Effect.withSpan("my-span"),
// the span will not have timing information
Effect.withTracerTiming(false)
)export const const withTracerTiming: {
(enabled: boolean): <A, E, R>(
effect: Effect<A, E, R>
) => Effect<A, E, R>
<A, E, R>(
effect: Effect<A, E, R>,
enabled: boolean
): Effect<A, E, R>
}
Enables or disables tracer timing for the given Effect.
Example (Enabling or disabling tracing timing)
import { Effect } from "effect"
Effect.succeed(42).pipe(
Effect.withSpan("my-span"),
// the span will not have timing information
Effect.withTracerTiming(false)
)
withTracerTiming: {
(enabled: booleanenabled: boolean): <function (type parameter) A in <A, E, R>(effect: Effect<A, E, R>): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect<A, E, R>): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect<A, E, R>): Effect<A, E, R>R>(effect: Effect<A, E, R>(parameter) effect: {
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>(effect: Effect<A, E, R>): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect<A, E, R>): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(effect: 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>(effect: Effect<A, E, R>): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect<A, E, R>): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect<A, E, R>): Effect<A, E, R>R>
<function (type parameter) A in <A, E, R>(effect: Effect<A, E, R>, enabled: boolean): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect<A, E, R>, enabled: boolean): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect<A, E, R>, enabled: boolean): Effect<A, E, R>R>(effect: Effect<A, E, R>(parameter) effect: {
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>(effect: Effect<A, E, R>, enabled: boolean): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect<A, E, R>, enabled: boolean): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect<A, E, R>, enabled: boolean): Effect<A, E, R>R>, enabled: booleanenabled: boolean): 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>(effect: Effect<A, E, R>, enabled: boolean): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect<A, E, R>, enabled: boolean): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect<A, E, R>, enabled: boolean): Effect<A, E, R>R>
} = import internalinternal.const withTracerTiming: {
(enabled: boolean): <A, E, R>(
effect: Effect.Effect<A, E, R>
) => Effect.Effect<A, E, R>
<A, E, R>(
effect: Effect.Effect<A, E, R>,
enabled: boolean
): Effect.Effect<A, E, R>
}