<Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top>(
tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>,
patch: ConfigPatch<
LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
never
>
>
): Layer.Layer<never>Config-patch layer for a tag — merge with layer (Tag path).
layers & servinglayer
Source src/Gate.ts:8986 lines
export const const configure: <
Self,
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top
>(
tag: HyperlinkTag<
Self,
InstanceSpec<I, A, E>,
any
>,
patch: ConfigPatch<
LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
never
>
>
) => Layer.Layer<never>
Config-patch layer for a tag — merge with
layer
(Tag path).
configure = <function (type parameter) Self in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, patch: ConfigPatch<LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, never>>): Layer.Layer<never>Self, function (type parameter) I in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, patch: ConfigPatch<LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, never>>): Layer.Layer<never>I extends import SchemaSchema.Top, function (type parameter) A in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, patch: ConfigPatch<LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, never>>): Layer.Layer<never>A extends import SchemaSchema.Top, function (type parameter) E in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, patch: ConfigPatch<LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, never>>): Layer.Layer<never>E extends import SchemaSchema.Top>(
tag: HyperlinkTag<
Self,
InstanceSpec<I, A, E>,
any
>
(parameter) tag: {
description: string | undefined;
key: Identifier;
of: (this: void, self: any) => any;
context: (self: any) => Context.Context<Self>;
use: (f: (service: any) => Effect.Effect<A, E, R>) => Effect.Effect<A, E, Self | R>;
useSync: (f: (service: any) => A) => Effect.Effect<A, never, Self>;
Identifier: Identifier;
Service: Shape;
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;
}
interface HyperlinkTag<Self, S extends Spec, Svc = Simplify<{ readonly [K in keyof S]: S[K] extends FromLocalMethod<infer M> ? InjectLocal<M, Self> : S[K] extends LocalMethod<infer T> ? LocalEffect<...> : S[K] extends DefaultMethod<...> ? F : S[K] extends { ...; } ? SuccessOf<...> : S[K] extends { ...; } ? Subscribable<...> : S[K] extends { ...; } ? ClientMethod<...> : S[K] extends Spec ? Simplify<...> : never; }>>The type of a HyperService tag carrying spec S — what
Hyperlink.Tag
produces
(and what you extend). Lets a consumer write
<S extends Spec>(tag: HyperlinkTag<Self, S>) and read the spec through named types
(
specOf
/
groupOf
) instead of a Parameters<typeof specOf> workaround.
HyperlinkTag<function (type parameter) Self in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, patch: ConfigPatch<LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, never>>): Layer.Layer<never>Self, type InstanceSpec<
I extends Schema.Top,
A extends Schema.Top,
E extends Schema.Top = Schema.Never
> = {
readonly status: GateStatusRef
readonly waiting: GateCountRef
readonly inFlight: GateCountRef
readonly completed: GateCountRef
readonly failed: GateCountRef
readonly interrupted: GateCountRef
readonly metrics: typeof gateMetricsNestSpec
readonly run: GateWireMember<I, A, E>
}
Instance spec for a gate typed by its wire schemas — namespaced short form of
internal GateInstanceSpec (import * as Gate → Gate.InstanceSpec).
InstanceSpec<function (type parameter) I in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, patch: ConfigPatch<LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, never>>): Layer.Layer<never>I, function (type parameter) A in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, patch: ConfigPatch<LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, never>>): Layer.Layer<never>A, function (type parameter) E in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, patch: ConfigPatch<LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, never>>): Layer.Layer<never>E>, any>,
patch: ConfigPatch<
LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
never
>
>
type ConfigPatch<T> = PartialConfigPatch<T> | ((previous: T) => T)Patch for a hyperlink or daemon spec.
- Partial object — shallow-merge fields; use a function value to replace a field.
effect field — a unary function (previous) => next updates the prior worker /
supervised body; a multi-argument function value replaces effect outright (queue workers
stay two-argument).- Full reducer —
(previous) => next over the whole spec (see
configureLayer
).
ConfigPatch<
interface LayerConfig<I, A, E, R>Layer / serve config — the tag carries wire schemas; this supplies the gated effect.
LayerConfig<import SchemaSchema.Schema.type Schema<out T>.Type<S> = S extends {
readonly Type: infer T;
} ? T : never
Extracts the decoded Type from a schema.
Example (Extracting the decoded type)
import { Schema } from "effect"
const Person = Schema.Struct({ name: Schema.String, age: Schema.Number })
type Person = Schema.Schema.Type<typeof Person>
// { readonly name: string; readonly age: number }
Type<function (type parameter) I in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, patch: ConfigPatch<LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, never>>): Layer.Layer<never>I>, import SchemaSchema.Schema.type Schema<out T>.Type<S> = S extends {
readonly Type: infer T;
} ? T : never
Extracts the decoded Type from a schema.
Example (Extracting the decoded type)
import { Schema } from "effect"
const Person = Schema.Struct({ name: Schema.String, age: Schema.Number })
type Person = Schema.Schema.Type<typeof Person>
// { readonly name: string; readonly age: number }
Type<function (type parameter) A in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, patch: ConfigPatch<LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, never>>): Layer.Layer<never>A>, import SchemaSchema.Schema.type Schema<out T>.Type<S> = S extends {
readonly Type: infer T;
} ? T : never
Extracts the decoded Type from a schema.
Example (Extracting the decoded type)
import { Schema } from "effect"
const Person = Schema.Struct({ name: Schema.String, age: Schema.Number })
type Person = Schema.Schema.Type<typeof Person>
// { readonly name: string; readonly age: number }
Type<function (type parameter) E in <Self, I extends Schema.Top, A extends Schema.Top, E extends Schema.Top>(tag: HyperlinkTag<Self, InstanceSpec<I, A, E>, any>, patch: ConfigPatch<LayerConfig<Schema.Schema.Type<I>, Schema.Schema.Type<A>, Schema.Schema.Type<E>, never>>): Layer.Layer<never>E>, never>
>,
): 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<never> => configureLayer<T extends object>(resourceId: string, patch: ConfigPatch<T>): Layer.Layer<never>Layer that appends one configure patch for resourceId.
Provide or merge with the HyperService .layer so patches are visible when that layer builds.
configureLayer(tag: HyperlinkTag<
Self,
InstanceSpec<I, A, E>,
any
>
(parameter) tag: {
description: string | undefined;
key: Identifier;
of: (this: void, self: any) => any;
context: (self: any) => Context.Context<Self>;
use: (f: (service: any) => Effect.Effect<A, E, R>) => Effect.Effect<A, E, Self | R>;
useSync: (f: (service: any) => A) => Effect.Effect<A, never, Self>;
Identifier: Identifier;
Service: Shape;
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;
}
ServiceClass<Self, string, any>.key: stringkey, patch: ConfigPatch<
LayerConfig<
Schema.Schema.Type<I>,
Schema.Schema.Type<A>,
Schema.Schema.Type<E>,
never
>
>