<A, E, R>(self: Effect<A, E, R>): Effect<
[duration: Duration.Duration, result: A],
E,
R
>Returns the runtime duration of an effect together with its result.
Details
The original success, failure, or interruption is preserved; only the success value is paired with the duration.
Example (Measuring execution time)
import { Console, Duration, Effect } from "effect"
const program = Effect.gen(function*() {
const [duration, value] = yield* Effect.timed(Effect.succeed("ok"))
yield* Console.log(`took ${Duration.toMillis(duration)}ms: ${value}`)
})export const const timed: <A, E, R>(
self: Effect<A, E, R>
) => Effect<
[duration: Duration.Duration, result: A],
E,
R
>
Returns the runtime duration of an effect together with its result.
Details
The original success, failure, or interruption is preserved; only the success
value is paired with the duration.
Example (Measuring execution time)
import { Console, Duration, Effect } from "effect"
const program = Effect.gen(function*() {
const [duration, value] = yield* Effect.timed(Effect.succeed("ok"))
yield* Console.log(`took ${Duration.toMillis(duration)}ms: ${value}`)
})
timed: <function (type parameter) A in <A, E, R>(self: Effect<A, E, R>): Effect<[duration: Duration.Duration, result: A], E, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<[duration: Duration.Duration, result: A], E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<[duration: Duration.Duration, result: 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<[duration: Duration.Duration, result: A], E, R>A, function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<[duration: Duration.Duration, result: A], E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<[duration: Duration.Duration, result: 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<[Duration.Durationduration: import DurationDuration.type Duration.Duration = /*unresolved*/ anyDuration, Aresult: function (type parameter) A in <A, E, R>(self: Effect<A, E, R>): Effect<[duration: Duration.Duration, result: A], E, R>A], function (type parameter) E in <A, E, R>(self: Effect<A, E, R>): Effect<[duration: Duration.Duration, result: A], E, R>E, function (type parameter) R in <A, E, R>(self: Effect<A, E, R>): Effect<[duration: Duration.Duration, result: A], E, R>R> =
import internalinternal.const timed: <A, E, R>(
self: Effect.Effect<A, E, R>
) => Effect.Effect<
[duration: Duration.Duration, result: A],
E,
R
>