(key: string, value: unknown): <A, E, R>(
effect: Effect<A, E, R>
) => Effect<A, E, R>
(values: Record<string, unknown>): <A, E, R>(
effect: Effect<A, E, R>
) => Effect<A, E, R>
<A, E, R>(effect: Effect<A, E, R>, key: string, value: unknown): Effect<
A,
E,
R
>
<A, E, R>(
effect: Effect<A, E, R>,
values: Record<string, unknown>
): Effect<A, E, R>Adds an annotation to each span in this effect.
Example (Annotating all spans)
import { Effect } from "effect"
const program = Effect.gen(function*() {
yield* Effect.log("Doing some work...")
return "result"
})
// Add single annotation
const annotated1 = Effect.annotateSpans(program, "user", "john")
// Add multiple annotations
const annotated2 = Effect.annotateSpans(program, {
operation: "data-processing",
version: "1.0.0",
environment: "production"
})export const const annotateSpans: {
(key: string, value: unknown): <A, E, R>(
effect: Effect<A, E, R>
) => Effect<A, E, R>
(values: Record<string, unknown>): <A, E, R>(
effect: Effect<A, E, R>
) => Effect<A, E, R>
<A, E, R>(
effect: Effect<A, E, R>,
key: string,
value: unknown
): Effect<A, E, R>
<A, E, R>(
effect: Effect<A, E, R>,
values: Record<string, unknown>
): Effect<A, E, R>
}
Adds an annotation to each span in this effect.
Example (Annotating all spans)
import { Effect } from "effect"
const program = Effect.gen(function*() {
yield* Effect.log("Doing some work...")
return "result"
})
// Add single annotation
const annotated1 = Effect.annotateSpans(program, "user", "john")
// Add multiple annotations
const annotated2 = Effect.annotateSpans(program, {
operation: "data-processing",
version: "1.0.0",
environment: "production"
})
annotateSpans: {
(
key: stringkey: string,
value: unknownvalue: unknown
): <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>
(
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>
): <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>, key: string, value: unknown): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect<A, E, R>, key: string, value: unknown): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect<A, E, R>, key: string, value: unknown): 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>, key: string, value: unknown): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect<A, E, R>, key: string, value: unknown): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect<A, E, R>, key: string, value: unknown): Effect<A, E, R>R>,
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<function (type parameter) A in <A, E, R>(effect: Effect<A, E, R>, key: string, value: unknown): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect<A, E, R>, key: string, value: unknown): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect<A, E, R>, key: string, value: unknown): Effect<A, E, R>R>
<function (type parameter) A in <A, E, R>(effect: Effect<A, E, R>, values: Record<string, unknown>): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect<A, E, R>, values: Record<string, unknown>): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect<A, E, R>, values: Record<string, unknown>): 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>, values: Record<string, unknown>): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect<A, E, R>, values: Record<string, unknown>): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect<A, E, R>, values: Record<string, unknown>): Effect<A, E, R>R>,
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<function (type parameter) A in <A, E, R>(effect: Effect<A, E, R>, values: Record<string, unknown>): Effect<A, E, R>A, function (type parameter) E in <A, E, R>(effect: Effect<A, E, R>, values: Record<string, unknown>): Effect<A, E, R>E, function (type parameter) R in <A, E, R>(effect: Effect<A, E, R>, values: Record<string, unknown>): Effect<A, E, R>R>
} = import internalinternal.const annotateSpans: {
(key: string, value: unknown): <A, E, R>(
effect: Effect.Effect<A, E, R>
) => Effect.Effect<A, E, R>
(values: Record<string, unknown>): <A, E, R>(
effect: Effect.Effect<A, E, R>
) => Effect.Effect<A, E, R>
<A, E, R>(
effect: Effect.Effect<A, E, R>,
key: string,
value: unknown
): Effect.Effect<A, E, R>
<A, E, R>(
effect: Effect.Effect<A, E, R>,
values: Record<string, unknown>
): Effect.Effect<A, E, R>
}