(key: string, value: unknown): Effect<void>
(values: Record<string, unknown>): Effect<void>Adds an annotation to the current span if available.
Example (Annotating the current span)
import { Effect } from "effect"
const program = Effect.gen(function*() {
yield* Effect.annotateCurrentSpan("userId", "123")
yield* Effect.annotateCurrentSpan({
operation: "user-lookup",
timestamp: Date.now()
})
yield* Effect.log("User lookup completed")
return "success"
})
const traced = Effect.withSpan(program, "user-operation")export const const annotateCurrentSpan: {
(key: string, value: unknown): Effect<void>
(values: Record<string, unknown>): Effect<void>
}
Adds an annotation to the current span if available.
Example (Annotating the current span)
import { Effect } from "effect"
const program = Effect.gen(function*() {
yield* Effect.annotateCurrentSpan("userId", "123")
yield* Effect.annotateCurrentSpan({
operation: "user-lookup",
timestamp: Date.now()
})
yield* Effect.log("User lookup completed")
return "success"
})
const traced = Effect.withSpan(program, "user-operation")
annotateCurrentSpan: {
(key: stringkey: string, value: unknownvalue: 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<void>
(values: Record<string, unknown>values: type Record<K extends keyof any, T> = {
[P in K]: T
}
Construct a type with a set of properties K of type T
Record<string, 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<void>
} = import internalinternal.const annotateCurrentSpan: {
(
key: string,
value: unknown
): Effect.Effect<void>
(
values: Record<string, unknown>
): Effect.Effect<void>
}