<Self>(tag: TelemetryTag<Self>, options?: TelemetryOptions): Layer.Layer<
Self | Hyperlink.Local<Self>,
never,
PeersId<Self> | SelfNodeId<Self>
>Local layer for a Telemetry tag — forks one sampling fiber and wires leaf + fleet fields. Requires the mesh capability (alone or Hyperlink.peersLayer).
Source src/Telemetry.ts:43712 lines
export const const layer: <Self>(
tag: TelemetryTag<Self>,
options?: TelemetryOptions
) => Layer.Layer<
Self | Hyperlink.Local<Self>,
never,
PeersId<Self> | SelfNodeId<Self>
>
Local layer for a Telemetry tag — forks one sampling fiber and wires leaf + fleet fields.
Requires the mesh capability (
alone
or
Hyperlink.peersLayer
).
layer = <function (type parameter) Self in <Self>(tag: TelemetryTag<Self>, options?: TelemetryOptions): Layer.Layer<Self | Hyperlink.Local<Self>, never, PeersId<Self> | SelfNodeId<Self>>Self>(
tag: TelemetryTag<Self>(parameter) tag: {
key: Identifier;
Service: {
snapshot: Effect.Effect<MetricsSnapshot, never, never>;
live: Stream.Stream<MetricsSnapshot, never, never>;
inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>;
fleetInFlight: Effect.Effect<number, never, never>;
};
description: string | undefined;
of: (this: void, self: { readonly snapshot: Effect.Effect<MetricsSnapshot, never, never>; readonly live: Stream.Stream<MetricsSnapshot, never, never>; readonly inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>; read…;
context: (self: { readonly snapshot: Effect.Effect<MetricsSnapshot, never, never>; readonly live: Stream.Stream<MetricsSnapshot, never, never>; readonly inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>; readonly fleetIn…;
use: (f: (service: { readonly snapshot: Effect.Effect<MetricsSnapshot, never, never>; readonly live: Stream.Stream<MetricsSnapshot, never, never>; readonly inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>; readonly …;
useSync: (f: (service: { readonly snapshot: Effect.Effect<MetricsSnapshot, never, never>; readonly live: Stream.Stream<MetricsSnapshot, never, never>; readonly inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>; readonly …;
Identifier: Identifier;
stack: string | undefined;
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;
}
type TelemetryTag<Self> = Hyperlink.HyperlinkTag<Self, {
snapshot: Hyperlink.Method<undefined, typeof MetricsSnapshot, Schema.Never, false, Hyperlink.MethodAnnotations & {
description: string;
}, Hyperlink.Derive>;
live: Hyperlink.Method<undefined, typeof MetricsSnapshot, Schema.Never, true, Hyperlink.MethodAnnotations & {
description: string;
}, Hyperlink.Derive>;
inFlightByNode: Hyperlink.Marked<Hyperlink.Method<undefined, Schema.$Record<Schema.String, Schema.Number>, Schema.Never, false, Hyperlink.MethodAnnotations & {
...;
}, Hyperlink.Derive>, {
...;
}>;
fleetInFlight: Hyperlink.Marked<...>;
}, {
...;
}>
A Telemetry instance tag.
TelemetryTag<function (type parameter) Self in <Self>(tag: TelemetryTag<Self>, options?: TelemetryOptions): Layer.Layer<Self | Hyperlink.Local<Self>, never, PeersId<Self> | SelfNodeId<Self>>Self>,
options: TelemetryOptionsoptions?: TelemetryOptions,
): import LayerLayer.interface Layer<in ROut, out E = never, out RIn = never>A Layer describes how to build one or more services for dependency injection.
When to use
Use to model construction of application services for dependency injection,
especially when services have dependencies, can fail during construction, or
need scoped setup and release.
Details
A Layer<ROut, E, RIn> represents ROut as the services this layer
provides, E as the possible errors during layer construction, and RIn as
the services this layer requires as dependencies.
Layer<
function (type parameter) Self in <Self>(tag: TelemetryTag<Self>, options?: TelemetryOptions): Layer.Layer<Self | Hyperlink.Local<Self>, never, PeersId<Self> | SelfNodeId<Self>>Self | import HyperlinkHyperlink.interface Local<in out Self>Granted only by a HyperService's local layer (
Hyperlink.layer
/
serve
) — never by
Hyperlink.client
. Local to this runtime's materialized impl for the tag (not a remote
client, not a peer). A
LocalMethod
carries it in its requirement channel, so calling a
non-serializable method against a client is a compile error (unsatisfied requirement); the
same call resolves when the local layer is provided. Branded by Self so one HyperService's local
layer can't unlock another's.
Local<function (type parameter) Self in <Self>(tag: TelemetryTag<Self>, options?: TelemetryOptions): Layer.Layer<Self | Hyperlink.Local<Self>, never, PeersId<Self> | SelfNodeId<Self>>Self>,
never,
interface PeersId<Self>Phantom brand for the per-HyperService
peers
capability, so distinct HyperServices' peer sets
don't collide in one context.
PeersId<function (type parameter) Self in <Self>(tag: TelemetryTag<Self>, options?: TelemetryOptions): Layer.Layer<Self | Hyperlink.Local<Self>, never, PeersId<Self> | SelfNodeId<Self>>Self> | interface SelfNodeId<Self>Phantom brand for the per-HyperService
selfNode
capability (which node this instance runs as),
so distinct HyperServices' self-node identities don't collide in one context.
SelfNodeId<function (type parameter) Self in <Self>(tag: TelemetryTag<Self>, options?: TelemetryOptions): Layer.Layer<Self | Hyperlink.Local<Self>, never, PeersId<Self> | SelfNodeId<Self>>Self>
> =>
const buildImpl: <Self>(
tag: TelemetryTag<Self>,
options?: TelemetryOptions
) => Effect.Effect<
{
readonly snapshot: Effect.Effect<MetricsSnapshot>
readonly live: Stream.Stream<MetricsSnapshot>
readonly inFlightByNode: Effect.Effect<
Readonly<Record<string, number>>
>
readonly fleetInFlight: Effect.Effect<number>
},
never,
Scope.Scope | PeersId<Self> | SelfNodeId<Self>
>
The served impl: leaf snapshot/live plus fleet folds over peers' leaf snapshots.
Resolves
Hyperlink.peers
/
Hyperlink.selfNode
once; members close over them.
buildImpl(tag: TelemetryTag<Self>(parameter) tag: {
key: Identifier;
Service: {
snapshot: Effect.Effect<MetricsSnapshot, never, never>;
live: Stream.Stream<MetricsSnapshot, never, never>;
inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>;
fleetInFlight: Effect.Effect<number, never, never>;
};
description: string | undefined;
of: (this: void, self: { readonly snapshot: Effect.Effect<MetricsSnapshot, never, never>; readonly live: Stream.Stream<MetricsSnapshot, never, never>; readonly inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>; read…;
context: (self: { readonly snapshot: Effect.Effect<MetricsSnapshot, never, never>; readonly live: Stream.Stream<MetricsSnapshot, never, never>; readonly inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>; readonly fleetIn…;
use: (f: (service: { readonly snapshot: Effect.Effect<MetricsSnapshot, never, never>; readonly live: Stream.Stream<MetricsSnapshot, never, never>; readonly inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>; readonly …;
useSync: (f: (service: { readonly snapshot: Effect.Effect<MetricsSnapshot, never, never>; readonly live: Stream.Stream<MetricsSnapshot, never, never>; readonly inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>; readonly …;
Identifier: Identifier;
stack: string | undefined;
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;
}
options: TelemetryOptionsoptions).Pipeable.pipe<Effect.Effect<{
readonly snapshot: Effect.Effect<MetricsSnapshot>;
readonly live: Stream.Stream<MetricsSnapshot>;
readonly inFlightByNode: Effect.Effect<Readonly<Record<string, number>>>;
readonly fleetInFlight: Effect.Effect<number>;
}, never, Hyperlink.PeersId<Self> | Hyperlink.SelfNodeId<Self> | Scope.Scope>, Effect.Effect<Layer.Layer<Self | Hyperlink.Local<Self>, never, never>, never, Hyperlink.PeersId<Self> | Hyperlink.SelfNodeId<Self> | Scope.Scope>, Layer.Layer<...>>(this: Effect.Effect<...>, ab: (_: Effect.Effect<...>) => Effect.Effect<...>, bc: (_: Effect.Effect<...>) => Layer.Layer<...>): Layer.Layer<...> (+21 overloads)
import EffectEffect.const map: {
<A, B>(f: (a: A) => B): <E, R>(
self: Effect<A, E, R>
) => Effect<B, E, R>
<A, E, R, B>(
self: Effect<A, E, R>,
f: (a: A) => B
): Effect<B, E, R>
}
Transforms the value inside an effect by applying a function to it.
When to use
Use to transform an effect's success value with a function that returns a
plain value, producing a new effect without changing the original effect's
typed error or context requirements.
Details
map takes a function and applies it to the value contained within an
effect, creating a new effect with the transformed value.
It's important to note that effects are immutable, meaning that the original
effect is not modified. Instead, a new effect is returned with the updated
value.
Example (Choosing map syntax variants)
import { Effect, pipe } from "effect"
const myEffect = Effect.succeed(1)
const transformation = (n: number) => n + 1
const mappedWithPipe = pipe(myEffect, Effect.map(transformation))
const mappedWithDataFirst = Effect.map(myEffect, transformation)
const mappedWithMethod = myEffect.pipe(Effect.map(transformation))
Example (Adding a service charge)
import { Effect, pipe } from "effect"
const addServiceCharge = (amount: number) => amount + 1
const fetchTransactionAmount = Effect.promise(() => Promise.resolve(100))
const finalAmount = pipe(
fetchTransactionAmount,
Effect.map(addServiceCharge)
)
Effect.runPromise(finalAmount).then(console.log)
// Output: 101
map((impl: {
readonly snapshot: Effect.Effect<MetricsSnapshot>
readonly live: Stream.Stream<MetricsSnapshot>
readonly inFlightByNode: Effect.Effect<
Readonly<Record<string, number>>
>
readonly fleetInFlight: Effect.Effect<number>
}
resourceLayer<Self, {
snapshot: Hyperlink.Method<undefined, typeof MetricsSnapshot, Schema.Never, false, Hyperlink.MethodAnnotations & {
description: string;
}, Hyperlink.Derive>;
live: Hyperlink.Method<undefined, typeof MetricsSnapshot, Schema.Never, true, Hyperlink.MethodAnnotations & {
description: string;
}, Hyperlink.Derive>;
inFlightByNode: Hyperlink.Marked<Hyperlink.Method<undefined, Schema.$Record<Schema.String, Schema.Number>, Schema.Never, false, Hyperlink.MethodAnnotations & {
...;
}, Hyperlink.Derive>, {
...;
}>;
fleetInFlight: Hyperlink.Marked<...>;
}>(tag: Hyperlink.HyperlinkTag<...>, impl: Hyperlink.ImplWithDefaultOverrides<...>): Layer.Layer<...> (+3 overloads)
tag: TelemetryTag<Self>(parameter) tag: {
key: Identifier;
Service: {
snapshot: Effect.Effect<MetricsSnapshot, never, never>;
live: Stream.Stream<MetricsSnapshot, never, never>;
inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>;
fleetInFlight: Effect.Effect<number, never, never>;
};
description: string | undefined;
of: (this: void, self: { readonly snapshot: Effect.Effect<MetricsSnapshot, never, never>; readonly live: Stream.Stream<MetricsSnapshot, never, never>; readonly inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>; read…;
context: (self: { readonly snapshot: Effect.Effect<MetricsSnapshot, never, never>; readonly live: Stream.Stream<MetricsSnapshot, never, never>; readonly inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>; readonly fleetIn…;
use: (f: (service: { readonly snapshot: Effect.Effect<MetricsSnapshot, never, never>; readonly live: Stream.Stream<MetricsSnapshot, never, never>; readonly inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>; readonly …;
useSync: (f: (service: { readonly snapshot: Effect.Effect<MetricsSnapshot, never, never>; readonly live: Stream.Stream<MetricsSnapshot, never, never>; readonly inFlightByNode: Effect.Effect<{ readonly [x: string]: number }, never, never>; readonly …;
Identifier: Identifier;
stack: string | undefined;
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;
}
impl: {
readonly snapshot: Effect.Effect<MetricsSnapshot>
readonly live: Stream.Stream<MetricsSnapshot>
readonly inFlightByNode: Effect.Effect<
Readonly<Record<string, number>>
>
readonly fleetInFlight: Effect.Effect<number>
}
import LayerLayer.const unwrap: <A, E1, R1, E, R>(
self: Effect<Layer<A, E1, R1>, E, R>
) => Layer<
A,
E | E1,
R1 | Exclude<R, Scope.Scope>
>
Unwraps a Layer from an Effect, flattening the nested structure.
When to use
Use when you have an Effect that produces a Layer and you want to
use that layer directly.
Details
The resulting Layer will have the combined error and dependency types from
both the outer Effect and the inner Layer.
Example (Unwrapping an effectful layer)
import { Context, Effect, Layer } from "effect"
class Database extends Context.Service<Database, {
readonly query: (sql: string) => Effect.Effect<string>
}>()("Database") {}
const layerEffect = Effect.succeed(
Layer.succeed(Database, { query: Effect.fn("Database.query")((sql: string) => Effect.succeed("result")) })
)
const unwrappedLayer = Layer.unwrap(layerEffect)
unwrap,
);